1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
<!-- ##### SECTION Title ##### -->
prelude-msg
<!-- ##### SECTION Short_Description ##### -->
Prelude Messaging API
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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
<programlisting>
8bits 8bits 8bits 8bits 32bits
+--------+--------+--------+----------+------------------------------+
|version | tag |priority| fragment | datalen |
+--------+--------+--------+----------+------------------------------+
</programlisting>
</para>
<para>
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.
<programlisting>
8bits 32bits 8bits
+--------+--------------------------------+-----------------+--------+
| tag | len | payload | 0xff |
+--------+--------------------------------+-----------------+--------+
</programlisting>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
prelude-msgbuf
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### TYPEDEF prelude_msg_t ##### -->
<para>
</para>
<!-- ##### ENUM prelude_msg_priority_t ##### -->
<para>
</para>
@PRELUDE_MSG_PRIORITY_NONE:
@PRELUDE_MSG_PRIORITY_LOW:
@PRELUDE_MSG_PRIORITY_MID:
@PRELUDE_MSG_PRIORITY_HIGH:
<!-- ##### FUNCTION prelude_msg_read ##### -->
<para>
</para>
@msg:
@pio:
@Returns:
<!-- ##### FUNCTION prelude_msg_forward ##### -->
<para>
</para>
@msg:
@dst:
@src:
@Returns:
<!-- ##### FUNCTION prelude_msg_get ##### -->
<para>
</para>
@msg:
@tag:
@len:
@buf:
@Returns:
<!-- ##### FUNCTION prelude_msg_recycle ##### -->
<para>
</para>
@msg:
<!-- ##### FUNCTION prelude_msg_mark_end ##### -->
<para>
</para>
@msg:
<!-- ##### FUNCTION prelude_msg_dynamic_new ##### -->
<para>
</para>
@ret:
@flush_msg_cb:
@data:
@Returns:
<!-- # Unused Parameters # -->
@tag:
@priority:
<!-- ##### FUNCTION prelude_msg_new ##### -->
<para>
</para>
@ret:
@msgcount:
@msglen:
@tag:
@priority:
@Returns:
<!-- ##### FUNCTION prelude_msg_set ##### -->
<para>
</para>
@msg:
@tag:
@len:
@data:
@Returns:
<!-- ##### FUNCTION prelude_msg_write ##### -->
<para>
</para>
@msg:
@dst:
@Returns:
<!-- ##### FUNCTION prelude_msg_set_tag ##### -->
<para>
</para>
@msg:
@tag:
<!-- ##### FUNCTION prelude_msg_set_priority ##### -->
<para>
</para>
@msg:
@priority:
<!-- ##### FUNCTION prelude_msg_get_tag ##### -->
<para>
</para>
@msg:
@Returns:
<!-- ##### FUNCTION prelude_msg_get_priority ##### -->
<para>
</para>
@msg:
@Returns:
<!-- ##### FUNCTION prelude_msg_get_len ##### -->
<para>
</para>
@msg:
@Returns:
<!-- ##### FUNCTION prelude_msg_get_datalen ##### -->
<para>
</para>
@msg:
@Returns:
|
