From 322f7a97dec445d35cd1f53e273a44cc4020b39f Mon Sep 17 00:00:00 2001
From: Michael Davidsaver <mdavidsaver@gmail.com>
Date: Mon, 31 Jul 2017 12:28:23 +0200
Subject: [PATCH] rsrv: add some comments

---
 src/rsrv/caserverio.c | 3 +++
 src/rsrv/server.h     | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/src/rsrv/caserverio.c b/src/rsrv/caserverio.c
index 387bf210b..b6cb4b92c 100644
--- a/src/rsrv/caserverio.c
+++ b/src/rsrv/caserverio.c
@@ -37,6 +37,9 @@
  *  cas_send_bs_msg()
  *
  *  (channel access server send message)
+ *
+ *
+ * Set lock_needed=1 unless SEND_LOCK() is held by caller
  */
 void cas_send_bs_msg ( struct client *pclient, int lock_needed )
 {
diff --git a/src/rsrv/server.h b/src/rsrv/server.h
index e4b947ea9..7edf62661 100644
--- a/src/rsrv/server.h
+++ b/src/rsrv/server.h
@@ -62,8 +62,10 @@ typedef struct caHdrLargeArray {
 enum messageBufferType { mbtUDP, mbtSmallTCP, mbtLargeTCP };
 struct message_buffer {
   char                      *buf;
+  /*! points to first filled byte in buffer */
   unsigned                  stk;
   unsigned                  maxstk;
+  /*! points to first unused byte in buffer (after filled bytes) */
   unsigned                  cnt;    
   enum messageBufferType    type;
 };
@@ -72,7 +74,9 @@ extern epicsThreadPrivateId rsrvCurrentClient;
 
 typedef struct client {
   ELLNODE               node;
+  /*! guarded by SEND_LOCK()  aka. client::lock */
   struct message_buffer send;
+  /*! accessed by receive thread w/o locks cf. camsgtask() */
   struct message_buffer recv;
   epicsMutexId          lock;
   epicsMutexId          putNotifyLock;