cosmetic: server: document functions

Change-Id: I6709b720e236514b8572fe60834a990558e67f5c
---
M src/osmo_server_network.c
1 file changed, 6 insertions(+), 0 deletions(-)


git pull ssh://gerrit.osmocom.org:29418/osmo-pcap refs/changes/70/39270/1

diff --git a/src/osmo_server_network.c b/src/osmo_server_network.c
index d55b30d..18836e5 100644
--- a/src/osmo_server_network.c
+++ b/src/osmo_server_network.c
@@ -610,6 +610,8 @@
 	return true;
 }
 
+/* Read segment header, struct osmo_pcap_data (without payload)
+ * returns >0 on success, <= 0 on failure (closes conn) */
 static int read_cb_initial(struct osmo_pcap_conn *conn)
 {
 	int rc;
@@ -639,6 +641,8 @@
 	return 1;
 }
 
+/* Read segment payload, of size conn->data->len.
+ * returns >0 on success, <= 0 on failure (closes conn) */
 static int read_cb_data(struct osmo_pcap_conn *conn)
 {
 	int rc;
@@ -680,6 +684,7 @@
 	return 1;
 }
 
+/* returns >0 on success, <= 0 on failure (closes conn) */
 static int dispatch_read(struct osmo_pcap_conn *conn)
 {
 	if (conn->state == STATE_INITIAL) {
@@ -760,6 +765,7 @@
 
 	rate_ctr_inc2(client->ctrg, PEER_CTR_CONNECT);
 
+	/* Prepare for first read of semgent header: */
 	client->state = STATE_INITIAL;
 	client->pend = sizeof(*client->data);
 

