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
2 changed files with 30 additions and 2 deletions
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".
[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"]
=== 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_^]):