diff --git a/README.adoc b/README.adoc index bda1eb8..a8a564b 100644 --- a/README.adoc +++ b/README.adoc @@ -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_^]): diff --git a/README.html b/README.html index 74150b9..0b9cd39 100644 --- a/README.html +++ b/README.html @@ -476,6 +476,10 @@ pre.rouge .gi { color: #116329; background-color: #dafbe1; } +pre.rouge .ges { + font-weight: bold; + font-style: italic; +} pre.rouge .kc { color: #0550ae; } @@ -632,7 +636,7 @@ pre.rouge .gs {
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 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". + |
+