add more docs to control flags

replit · Nov 15, 2023 · 2aad254 · 2aad254
1 parent c9606c1
commit 2aad254
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/transport/message.ts b/transport/message.ts
@@ -3,6 +3,10 @@ import { nanoid } from 'nanoid';
 
 /**
  * Control flags for transport messages.
+ * An RPC message is coded with StreamOpenBit | StreamClosedBit.
+ * Streams are expected to start with StreamOpenBit sent and the client SHOULD send an empty
+ * message with StreamClosedBit to close the stream handler on the server, indicating that
+ * it will not be using the stream anymore.
  */
 export const enum ControlFlags {
   AckBit = 0b0001,