project_files/frontlib/ipcconn.h
changeset 7173 7c2eb284f9f1
parent 7171 906e72caea7b
child 7175 038e3415100a
--- a/project_files/frontlib/ipcconn.h	Sun Jun 03 01:24:18 2012 +0200
+++ b/project_files/frontlib/ipcconn.h	Mon Jun 04 21:12:20 2012 +0200
@@ -43,10 +43,13 @@
 IpcConnState flib_ipcconn_state(flib_ipcconn ipc);
 
 /**
- * Receive a single message (up to 255 bytes) and copy it into the data buffer.
+ * Receive a single message (up to 256 bytes) and copy it into the data buffer.
  * Returns the length of the received message, a negative value if no message could
  * be read.
  *
+ * The first byte of a message is its content length, which is one less than the returned
+ * value.
+ *
  * Note: When a connection is closed, you probably want to call this function until
  * no further message is returned, to ensure you see all messages that were sent
  * before the connection closed.