Skip to content

Commit

Permalink
Deploying to gh-pages from @ c3739af 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@twyatt
twyatt committed Mar 15, 2024
1 parent c6d69c3 commit 1515124
Show file tree
Hide file tree
Showing 109 changed files with 245 additions and 213 deletions.
3 changes: 3 additions & 0 deletions docs/images/homepage.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/-tcp/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="length.html">length</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><div class="brief "><p class="paragraph">Length (in bytes) of message content (Options + Payload).</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="length.html">length</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><div class="brief "><p class="paragraph">Length (in bytes) of message content (Options + Payload).</p></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/-tcp/length.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>length</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="length.html">length</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Length (in bytes) of message content (Options + Payload).</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="length.html">length</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Length (in bytes) of message content (Options + Payload).</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
6 changes: 3 additions & 3 deletions docs/koap/com.juul.koap/-header/-udp/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-id.html">messageId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="message-id.html">messageId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -142,7 +142,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-message/-udp/-type/index.html">Message.Udp.Type</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-message/-udp/-type/index.html">Message.Udp.Type</a></div></div></div>
</div>
</div>
</div>
Expand All @@ -157,7 +157,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="version.html">version</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="version.html">version</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/-udp/message-id.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span>message</span><wbr></wbr><span><span>Id</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-id.html">messageId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="message-id.html">messageId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/-udp/type.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>type</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-message/-udp/-type/index.html">Message.Udp.Type</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-message/-udp/-type/index.html">Message.Udp.Type</a></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/-udp/version.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>version</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="version.html">version</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="version.html">version</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/code.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>code</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="code.html">code</a><span class="token operator">: </span><a href="../-message/-code/index.html">Message.Code</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="code.html">code</a><span class="token operator">: </span><a href="../-message/-code/index.html">Message.Code</a></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
6 changes: 3 additions & 3 deletions docs/koap/com.juul.koap/-header/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="code.html">code</a><span class="token operator">: </span><a href="../-message/-code/index.html">Message.Code</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="code.html">code</a><span class="token operator">: </span><a href="../-message/-code/index.html">Message.Code</a></div></div></div>
</div>
</div>
</div>
Expand All @@ -131,7 +131,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="size.html">size</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Size (in bytes) of the encoded CoAP header.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="size.html">size</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Size (in bytes) of the encoded CoAP header.</p></div></div></div>
</div>
</div>
</div>
Expand All @@ -146,7 +146,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="token.html">token</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><div class="brief "><p class="paragraph">Per RFC 7252 2.2. Request/Response Model:</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="token.html">token</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><div class="brief "><p class="paragraph">Per RFC 7252 2.2. Request/Response Model:</p></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/size.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>size</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="size.html">size</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Size (in bytes) of the encoded CoAP header.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="size.html">size</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Size (in bytes) of the encoded CoAP header.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion docs/koap/com.juul.koap/-header/token.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>token</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="token.html">token</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Per RFC 7252 2.2. Request/Response Model:</p><blockquote class="quotation"><p class="paragraph">A Token is used to match responses to requests independently from the underlying messages.</p></blockquote><p class="paragraph">A token may be 0-8 bytes, whereas <a href="token.html">token</a> is represented as a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>. The following ranges outline the number of bytes that will be occupied when encoded as CoAP.</p><table><thead><tr><th>Range</th><th>Bytes</th></tr></thead><tbody><tr><td>-2^63 .. -1</td><td>8</td></tr><tr><td>1 .. 255</td><td>1</td></tr><tr><td>256 .. 65,635</td><td>2</td></tr><tr><td>65,536 .. 4,294,967,295</td><td>4</td></tr><tr><td>4,294,967,296 .. 2^63-1</td><td>8</td></tr></tbody></table><p class="paragraph"><i>A token of value </i><code class="italic lang-kotlin"><i>0</i></code><i> will occupy </i><code class="italic lang-kotlin"><i>0</i></code><i> bytes.</i></p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":koap:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="token.html">token</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Per RFC 7252 2.2. Request/Response Model:</p><blockquote class="quotation"><p class="paragraph">A Token is used to match responses to requests independently from the underlying messages.</p></blockquote><p class="paragraph">A token may be 0-8 bytes, whereas <a href="token.html">token</a> is represented as a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>. The following ranges outline the number of bytes that will be occupied when encoded as CoAP.</p><table><thead><tr><th>Range</th><th>Bytes</th></tr></thead><tbody><tr><td>-2^63 .. -1</td><td>8</td></tr><tr><td>1 .. 255</td><td>1</td></tr><tr><td>256 .. 65,635</td><td>2</td></tr><tr><td>65,536 .. 4,294,967,295</td><td>4</td></tr><tr><td>4,294,967,296 .. 2^63-1</td><td>8</td></tr></tbody></table><p class="paragraph"><i>A token of value </i><code class="italic lang-kotlin"><i>0</i></code><i> will occupy </i><code class="italic lang-kotlin"><i>0</i></code><i> bytes.</i></p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
Loading

0 comments on commit 1515124

Please sign in to comment.