project_files/frontlib/ipcconn.h
changeset 7173 7c2eb284f9f1
parent 7171 906e72caea7b
child 7175 038e3415100a
equal deleted inserted replaced
7171:906e72caea7b 7173:7c2eb284f9f1
    41  * Determine the current connection state
    41  * Determine the current connection state
    42  */
    42  */
    43 IpcConnState flib_ipcconn_state(flib_ipcconn ipc);
    43 IpcConnState flib_ipcconn_state(flib_ipcconn ipc);
    44 
    44 
    45 /**
    45 /**
    46  * Receive a single message (up to 255 bytes) and copy it into the data buffer.
    46  * Receive a single message (up to 256 bytes) and copy it into the data buffer.
    47  * Returns the length of the received message, a negative value if no message could
    47  * Returns the length of the received message, a negative value if no message could
    48  * be read.
    48  * be read.
       
    49  *
       
    50  * The first byte of a message is its content length, which is one less than the returned
       
    51  * value.
    49  *
    52  *
    50  * Note: When a connection is closed, you probably want to call this function until
    53  * Note: When a connection is closed, you probably want to call this function until
    51  * no further message is returned, to ensure you see all messages that were sent
    54  * no further message is returned, to ensure you see all messages that were sent
    52  * before the connection closed.
    55  * before the connection closed.
    53  */
    56  */