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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
|
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>nevrax.org : docs</TITLE>
<LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
<TR>
<TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD>
<TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD>
</TR>
</TABLE>
<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
<TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>
<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
<TR>
<TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
<TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
<!------ Begin Box ------>
<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
<TABLE cellspacing=0 cellpadding=1 border=0>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
</TABLE>
</TD></TR></TABLE></TD></TR></TABLE>
<!------ End Box ------>
</TD>
<TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
<!-- title -->
<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
<!-- block -->
<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
<TD><B>Documentation</B></TD>
<TD ALIGN=RIGHT> </td>
</tr></table>
<!-- Generated by Doxygen 1.2.2 on Sat May 26 22:32:08 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center>
<hr><h1>NLNET::CMessage Class Reference</h1>Message memory stream for network.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="message_h-source.html">message.h</a>></code>
<p>
Inheritance diagram for NLNET::CMessage<p><center><img src="class_NLNET__CMessage_inherit_graph.gif" border="0" usemap="#NLNET::CMessage_inherit_map" alt="Inheritance graph"></center>
<map name="NLNET::CMessage_inherit_map">
<area href="class_NLMISC__CStringStream.html" shape="rect" coords="0,134,149,152">
<area href="class_NLMISC__CMemStream.html" shape="rect" coords="3,67,147,86">
<area href="class_NLMISC__IStream.html" shape="rect" coords="19,0,131,19">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NLNET::CMessage:<p><center><img src="class_NLNET__CMessage_coll_graph.gif" border="0" usemap="#NLNET::CMessage_coll_map" alt="Collaboration graph"></center>
<map name="NLNET::CMessage_coll_map">
<area href="class_NLMISC__CStringStream.html" shape="rect" coords="0,139,149,157">
<area href="class_NLMISC__CMemStream.html" shape="rect" coords="3,69,147,88">
<area href="class_NLMISC__IStream.html" shape="rect" coords="19,0,131,19">
<area href="class_NLMISC__CStringIdArray.html" shape="rect" coords="173,139,328,157">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_NLNET__CMessage-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a0">CMessage</a> (<a class="el" href="class_NLMISC__CStringIdArray.html">NLMISC::CStringIdArray</a> &sida, const std::string &name = "", bool inputStream = false, <a class="el" href="types_nl_h.html#a9">uint32</a> defaultCapacity = 0)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a1">CMessage</a> (const std::string &name = "", bool inputStream = false, <a class="el" href="types_nl_h.html#a9">uint32</a> defaultCapacity = 0)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a2">CMessage</a> ( <a class="el" href="class_NLMISC__CStringStream.html">NLMISC::CStringStream</a> &memstr)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a3">CMessage</a> (const CMessage &other)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy constructor.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CMessage& </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a4">operator=</a> (const CMessage &other)</td></tr>
<tr><td> </td><td><font size=-1><em>Assignment operator.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a5">setType</a> (<a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> id)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the message type as a number (in range 0..32767) and put it in the buffer if we are in writing mode.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a6">setType</a> (const std::string &name)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the message type as a string and put it in the buffer if we are in writing mode.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a9">uint32</a> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a7">getHeaderSize</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size, in byte of the header that contains the type name of the message or the type number.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a8">readType</a> ()</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a9">typeIsSet</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a10">clear</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Clears the message.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a11">getName</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the type name in string if available. Be sure that the message have the name of the message type.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a12">getId</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the type id of this message is available.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#a13">toString</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a readable string to display it to the screen.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#m0">TypeHasAnId</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#m1">TypeHasAName</a></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#o0">_TypeSet</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_NLMISC__CStringIdArray.html">NLMISC::CStringIdArray</a>* </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#o1">_SIDA</a></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#o2">_Name</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#o3">_Id</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="types_nl_h.html#a9">uint32</a> </td><td valign=bottom><a class="el" href="class_NLNET__CMessage.html#o4">_HeaderSize</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Message memory stream for network.
<p>
Can be serialized to/from (see SerialBuffer()). Can be sent or received over a network, using the NeL network engine. If MESSAGES_PLAIN_TEXT is defined, the messages will be serialized to/from plain text (human-readable), instead of binary. Warning: if you don't give a "sida", the message type will not be associated with id so, it'll not be optimized
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
Vianney Lecroart , Nevrax France </dl><dl compact><dt>
<b>Date: </b><dd>
2001 </dl>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00066">66</a> of file <a class="el" href="message_h-source.html">message.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="NLNET::CMessage::CMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NLNET::CMessage::CMessage (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_NLMISC__CStringIdArray.html">NLMISC::CStringIdArray</a> & <em>sida</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const std::string & <em>name</em> = "",
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>inputStream</em> = false,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="types_nl_h.html#a9">uint32</a> <em>defaultCapacity</em> = 0 )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00073">73</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a1" doxytag="NLNET::CMessage::CMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NLNET::CMessage::CMessage (
</b></td>
<td valign="bottom"><b>
const std::string & <em>name</em> = "",
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>inputStream</em> = false,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="types_nl_h.html#a9">uint32</a> <em>defaultCapacity</em> = 0 )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00085">85</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a2" doxytag="NLNET::CMessage::CMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NLNET::CMessage::CMessage (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_NLMISC__CStringStream.html">NLMISC::CStringStream</a> & <em>memstr</em> )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00098">98</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a3" doxytag="NLNET::CMessage::CMessage"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NLNET::CMessage::CMessage (
</b></td>
<td valign="bottom"><b>
const CMessage & <em>other</em> )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy constructor.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00124">124</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a10" doxytag="NLNET::CMessage::clear"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void NLNET::CMessage::clear (
</b></td>
<td valign="bottom"><b>
void )<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Clears the message.
<p>
<p>
Reimplemented from <a class="el" href="class_NLMISC__CMemStream.html#a7">NLMISC::CMemStream</a>.
<p>
Definition at line <a class="el" href="message_h-source.html#l00250">250</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a7" doxytag="NLNET::CMessage::getHeaderSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="types_nl_h.html#a9">uint32</a> NLNET::CMessage::getHeaderSize (
</b></td>
<td valign="bottom"><b>
)<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the size, in byte of the header that contains the type name of the message or the type number.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00215">215</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a12" doxytag="NLNET::CMessage::getId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> NLNET::CMessage::getId (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the type id of this message is available.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00260">260</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a11" doxytag="NLNET::CMessage::getName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
std::string NLNET::CMessage::getName (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the type name in string if available. Be sure that the message have the name of the message type.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00257">257</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a4" doxytag="NLNET::CMessage::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
CMessage & NLNET::CMessage::operator= (
</b></td>
<td valign="bottom"><b>
const CMessage & <em>other</em> )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assignment operator.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00130">130</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a8" doxytag="NLNET::CMessage::readType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void NLNET::CMessage::readType (
</b></td>
<td valign="bottom"><b>
)<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00223">223</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a6" doxytag="NLNET::CMessage::setType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void NLNET::CMessage::setType (
</b></td>
<td valign="bottom"><b>
const std::string & <em>name</em> )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the message type as a string and put it in the buffer if we are in writing mode.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00174">174</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a5" doxytag="NLNET::CMessage::setType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void NLNET::CMessage::setType (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> <em>id</em> )<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the message type as a number (in range 0..32767) and put it in the buffer if we are in writing mode.
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00139">139</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a13" doxytag="NLNET::CMessage::toString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
std::string NLNET::CMessage::toString (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a readable string to display it to the screen.
<p>
It's only for debugging purpose! Don't use it for anything else than to debugging, the string format could change in the futur
<p>
Definition at line <a class="el" href="message_h-source.html#l00265">265</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="a9" doxytag="NLNET::CMessage::typeIsSet"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool NLNET::CMessage::typeIsSet (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00244">244</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m1" doxytag="NLNET::CMessage::TypeHasAName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool NLNET::CMessage::TypeHasAName
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00277">277</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="m0" doxytag="NLNET::CMessage::TypeHasAnId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool NLNET::CMessage::TypeHasAnId
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00276">276</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="o4" doxytag="NLNET::CMessage::_HeaderSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="types_nl_h.html#a9">uint32</a> NLNET::CMessage::_HeaderSize<code> [private]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00287">287</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="o3" doxytag="NLNET::CMessage::_Id"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_NLMISC__CStringIdArray.html#s0">NLMISC::CStringIdArray::TStringId</a> NLNET::CMessage::_Id<code> [private]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00284">284</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="o2" doxytag="NLNET::CMessage::_Name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
std::string NLNET::CMessage::_Name<code> [private]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00283">283</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="o1" doxytag="NLNET::CMessage::_SIDA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_NLMISC__CStringIdArray.html">NLMISC::CStringIdArray</a> * NLNET::CMessage::_SIDA<code> [private]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00281">281</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<a name="o0" doxytag="NLNET::CMessage::_TypeSet"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool NLNET::CMessage::_TypeSet<code> [private]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="message_h-source.html#l00280">280</a> of file <a class="el" href="message_h-source.html">message.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="message_h-source.html">message.h</a></ul>
<!-- footer -->
<BR><FONT Size=+5> </FONT>
</TD>
<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
