Merge #3446

3446: LocalStateQuery: document all messages r=coot a=coot Document * `MsgRelease` * `MsgDone` Fixes #3445. Co-authored-by: Marcin Szamotulski <profunctor@pm.me>
IntersectMBO · Oct 29, 2021 · 5743fdf · 5743fdf
2 parents 3f16f61 + 4b6378f
commit 5743fdf
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/docs/network-spec/miniprotocols.tex b/docs/network-spec/miniprotocols.tex
@@ -372,8 +372,6 @@ \subsection{Description}
 and the protocol parameters that are used by the client and the server.
 It is run exactly once when a new connection is initialised
 and consists of a single request from the client and a single reply from the server.
-Section \ref{peer-setup-section} explains the live cycle of a connection and the role of
-the handshake mini protocol in more detail.
 
 The handshake mini protocol is a generic protocol that can negotiate any kind protocol parameters.
 It only assumes that protocol parameters can be encoded to, and decoded from, CBOR terms.
@@ -1291,13 +1289,17 @@ \subsection{State machine}
     \node[state, myblue, right of=Idle] (Acquiring) {\StAcquiring};
     \node[state, mygreen, right of=Acquiring] (Acquired) {\StAcquired};
     \node[state, myblue, right of=Acquired] (Querying) {\StQuerying};
+    \node[state,         below of=Idle] (Done) {\StDone};
 
     \draw (Idle)      edge[bend left=45] node{\MsgAcquire}   (Acquiring);
     \draw (Acquiring) edge[bend left=45] node{\MsgFailure}   (Idle);
     \draw (Acquiring) edge[bend left=45] node{\MsgAcquired}  (Acquired);
     \draw (Acquired)  edge[bend left=45] node{\MsgReAcquire} (Acquiring);
     \draw (Acquired)  edge[bend left=45] node{\MsgQuery}     (Querying);
+    \draw (Acquired.275)
+                      to[in=-65, out=-115] node{\MsgRelease} (Idle.260);
     \draw (Querying)  edge[bend left=45] node{\MsgResult}    (Acquired);
+    \draw (Idle)      edge node[left]{\MsgDone}                    (Done)
   \end{tikzpicture}
   \caption{State machine of the Local State Query mini-protocol.}
 \end{figure}
@@ -1312,9 +1314,11 @@ \subsection{State machine}
     \StIdle             & \MsgAcquire         & $Maybe\ point$      & \StAcquiring \\\hline
     \StAcquiring        & \MsgFailure         & $AcquireFailure$    & \StIdle      \\\hline
     \StAcquiring        & \MsgAcquired        &                     & \StAcquired  \\\hline
-    \StAcquired         & \MsgReAcquire       & $Maybe\ point$      & \StAcquiring \\\hline
     \StAcquired         & \MsgQuery           & $query$             & \StQuerying  \\\hline
     \StQuerying         & \MsgResult          & $result$            & \StAcquired  \\\hline
+    \StAcquired         & \MsgReAcquire       & $Maybe\ point$      & \StAcquiring \\\hline
+    \StAcquired         & \MsgRelease         &                     & \StIdle      \\\hline
+    \StIdle             & \MsgDone            &                     & \StDone        \\\hline
   \end{tabular}
   \caption{Local State Query mini-protocol messages.}
 \end{figure}