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

quick note about announcement contexts

Browse Source
This commit is contained in:
brent saner 2025-08-28 01:03:43 -04:00
parent fe2a32e55c
commit de45bbab3f
Signed by: bts
GPG Key ID: 8C004C2F93481F6B
2 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.adoc
View File

@ -72,6 +72,13 @@ WireProto indicates two types of Messages/communication ends: a _Requester_ (_Re
This terminology is intentionally implementation-agnostic. A _Requester_ is any end of a communication that is *requesting data*, and the _Responder_ is any end of a communication that is *providing that data*. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both -- likewise for a "server". This terminology is intentionally implementation-agnostic. A _Requester_ is any end of a communication that is *requesting data*, and the _Responder_ is any end of a communication that is *providing that data*. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both -- likewise for a "server".
[NOTE]
====
In some cases (e.g. in the case of https://annnet.io/[AnnNet^], the initial message may not be a request; it may instead be an announce message that requires no response.
The "Requester" terminology is still used in this case even though no actual "request" is made/no response is necessary. This is congruent with the possibility of a Responder "not always be[ing] present".
====
[id="lib"] [id="lib"]
=== Reference Library === Reference Library
The WireProto specification is accompanied by a reference library for Golang, https://git.r00t2.io/r00t2/go_wireproto["WireProto"^] (https://git.r00t2.io/r00t2/wireproto[_source_^]): The WireProto specification is accompanied by a reference library for Golang, https://git.r00t2.io/r00t2/go_wireproto["WireProto"^] (https://git.r00t2.io/r00t2/wireproto[_source_^]):

25
README.html
View File

@ -476,6 +476,10 @@ pre.rouge .gi {
color: #116329; color: #116329;
background-color: #dafbe1; background-color: #dafbe1;
} }
pre.rouge .ges {
font-weight: bold;
font-style: italic;
}
pre.rouge .kc { pre.rouge .kc {
color: #0550ae; color: #0550ae;
} }
@ -632,7 +636,7 @@ pre.rouge .gs {
<div class="details"> <div class="details">
<span id="author" class="author">Brent Saner</span><br> <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="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 01:17:03 -0400</span> <span id="revdate">Last rendered 2025-08-28 01:03:43 -0400</span>
</div> </div>
<div id="toc" class="toc2"> <div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div> <div id="toctitle">Table of Contents</div>
@ -1263,6 +1267,23 @@ In the event of the embedded text in this document differing from the online ver
<div class="paragraph"> <div class="paragraph">
<p>This terminology is intentionally implementation-agnostic. A <em>Requester</em> is any end of a communication that is <strong>requesting data</strong>, and the <em>Responder</em> is any end of a communication that is <strong>providing that data</strong>. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both&#8201;&#8212;&#8201;likewise for a "server".</p> <p>This terminology is intentionally implementation-agnostic. A <em>Requester</em> is any end of a communication that is <strong>requesting data</strong>, and the <em>Responder</em> is any end of a communication that is <strong>providing that data</strong>. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both&#8201;&#8212;&#8201;likewise for a "server".</p>
</div> </div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>In some cases (e.g. in the case of <a href="https://annnet.io/" target="_blank" rel="noopener">AnnNet</a>, the initial message may not be a request; it may instead be an announce message that requires no response.</p>
</div>
<div class="paragraph">
<p>The "Requester" terminology is still used in this case even though no actual "request" is made/no response is necessary. This is congruent with the possibility of a Responder "not always be[ing] present".</p>
</div>
</td>
</tr>
</table>
</div>
</div> </div>
<div class="sect2"> <div class="sect2">
<h3 id="lib"><a class="link" href="#lib">2.2. Reference Library</a></h3> <h3 id="lib"><a class="link" href="#lib">2.2. Reference Library</a></h3>
@ -2368,7 +2389,7 @@ ae88bed2 // Checksum Value (2928197330)
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2024-07-10 01:16:51 -0400 Last updated 2025-08-28 01:02:58 -0400
</div> </div>
</div> </div>
</body> </body>