prelude-msg
Prelude Messaging API
This Mesaging API is used for differents Prelude program to communicate
together. It feature compatibility between version, and use a way to describe
data similar to XML.
The Message header contain the protocol version, which is only to be used
in case the main protocol structure change (compatibility break), The tag
describe the kind of message, The fragment field may be used if a message
is sent in several time, The priority may be used by the receiving end
to priorityze task, The datalen contain the size of the whole message in
network byte order
8bits 8bits 8bits 8bits 32bits
+--------+--------+--------+----------+------------------------------+
|version | tag |priority| fragment | datalen |
+--------+--------+--------+----------+------------------------------+
Then the message itself contain submessage composed of :
A tag describing the kind of payload, the len of the payload (in network byte order),
the payload itself, and an end of message byte (0xff) in order to resynchronize in
case of problem.
8bits 32bits 8bits
+--------+--------------------------------+-----------------+--------+
| tag | len | payload | 0xff |
+--------+--------------------------------+-----------------+--------+
prelude-msgbuf
@PRELUDE_MSG_PRIORITY_NONE:
@PRELUDE_MSG_PRIORITY_LOW:
@PRELUDE_MSG_PRIORITY_MID:
@PRELUDE_MSG_PRIORITY_HIGH:
@msg:
@pio:
@Returns:
@msg:
@dst:
@src:
@Returns:
@msg:
@tag:
@len:
@buf:
@Returns:
@msg:
@msg:
@ret:
@flush_msg_cb:
@data:
@Returns:
@ret:
@msgcount:
@msglen:
@tag:
@priority:
@Returns:
@msg:
@tag:
@len:
@data:
@Returns:
@msg:
@dst:
@Returns:
@msg:
@tag:
@msg:
@priority:
@msg:
@Returns:
@msg:
@Returns:
@msg:
@Returns:
@msg:
@Returns: