r00t2/WireProto
SHA256
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update ref links

Browse Source
This commit is contained in:
brent saner 2024-07-10 01:17:03 -04:00
parent 4e317bd8d2
commit fe2a32e55c
Signed by: bts
GPG Key ID: 8C004C2F93481F6B
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.adoc
View File

@ -52,7 +52,7 @@ NOTE: In the event of the embedded text in this document differing from the onli

[id="proto"]
== Protocol
The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key[OpenSSH "v1" key format^] https://git.r00t2.io/r00t2/go_sshkeys/src/branch/master/_ref/KEY_GUIDE.html#v1_plain_2[(example/details)] packing method.
The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key[OpenSSH "v1" key format^] https://sshref.dev[(example/details via sshref.dev)^] packing method.

It supports arbitrary binary values, which means they can be anything according to the implementation-specific details; a common practice is to encode ("marshal") a Go struct to JSON bytes, and set that as a WireProto field's value.

@ -120,7 +120,7 @@ Throughout this document, you may see references to things like `LF`, `SOH`, and

These refer to _ASCII control characters_. You will also see many values represented in hex.

You can find more details about this (along with a full ASCII reference) https://square-r00t.net/ascii.html[here^]. Note that the specification fully supports UTF-8 (or any other arbitrary encoding) -- just be sure that your <<alloc_size, size allocators>> are aligned to the *byte count* and not *character count* (as these may not be equal depending on encoding).
You can find more details about this (along with a full ASCII reference) at https://asciiref.dev/[asciiref.dev^]. Note that the specification fully supports UTF-8 (or any other arbitrary encoding) -- just be sure that your <<alloc_size, size allocators>> are aligned to the *byte count* and not *character count* (as these may not be equal depending on encoding).
====

Each *message* is composed of:

8
README.html
View File

@ -632,7 +632,7 @@ pre.rouge .gs {
<div class="details">
<span id="author" class="author">Brent Saner</span><br>
<span id="email" class="email"><a href="mailto:bts@square-r00t.net">bts@square-r00t.net</a></span><br>
<span id="revdate">Last rendered 2024-07-10 00:43:17 -0400</span>
<span id="revdate">Last rendered 2024-07-10 01:17:03 -0400</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
@ -1235,7 +1235,7 @@ In the event of the embedded text in this document differing from the online ver
<h2 id="proto"><a class="link" href="#proto">2. Protocol</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key" target="_blank" rel="noopener">OpenSSH "v1" key format</a> <a href="https://git.r00t2.io/r00t2/go_sshkeys/src/branch/master/_ref/KEY_GUIDE.html#v1_plain_2">(example/details)</a> packing method.</p>
<p>The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key" target="_blank" rel="noopener">OpenSSH "v1" key format</a> <a href="https://sshref.dev" target="_blank" rel="noopener">(example/details via sshref.dev)</a> packing method.</p>
</div>
<div class="paragraph">
<p>It supports arbitrary binary values, which means they can be anything according to the implementation-specific details; a common practice is to encode ("marshal") a Go struct to JSON bytes, and set that as a WireProto field&#8217;s value.</p>
@ -1348,7 +1348,7 @@ In the event of the embedded text in this document differing from the online ver
<p>These refer to <em>ASCII control characters</em>. You will also see many values represented in hex.</p>
</div>
<div class="paragraph">
<p>You can find more details about this (along with a full ASCII reference) <a href="https://square-r00t.net/ascii.html" target="_blank" rel="noopener">here</a>. Note that the specification fully supports UTF-8 (or any other arbitrary encoding)&#8201;&#8212;&#8201;just be sure that your <a href="#alloc_size">size allocators</a> are aligned to the <strong>byte count</strong> and not <strong>character count</strong> (as these may not be equal depending on encoding).</p>
<p>You can find more details about this (along with a full ASCII reference) at <a href="https://asciiref.dev/" target="_blank" rel="noopener">asciiref.dev</a>. Note that the specification fully supports UTF-8 (or any other arbitrary encoding)&#8201;&#8212;&#8201;just be sure that your <a href="#alloc_size">size allocators</a> are aligned to the <strong>byte count</strong> and not <strong>character count</strong> (as these may not be equal depending on encoding).</p>
</div>
</td>
</tr>
@ -2368,7 +2368,7 @@ ae88bed2 // Checksum Value (2928197330)
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-10 00:43:06 -0400
Last updated 2024-07-10 01:16:51 -0400
</div>
</div>
</body>