aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/libvoclient/doc/html/vocMsg_8c.html
blob: 1219ab9d8ad5102858ffa9367a47f6360cc476ea (plain) (blame)
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
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VOClient API: vocMsg.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vocMsg.c File Reference</h1><code>#include &lt;stdio.h&gt;</code><br>
<code>#include &lt;string.h&gt;</code><br>
<code>#include &lt;stddef.h&gt;</code><br>
<code>#include &lt;stdlib.h&gt;</code><br>
<code>#include &lt;unistd.h&gt;</code><br>
<code>#include &lt;ctype.h&gt;</code><br>
<code>#include &lt;pthread.h&gt;</code><br>
<code>#include &lt;sys/file.h&gt;</code><br>
<code>#include &lt;sys/types.h&gt;</code><br>
<code>#include &lt;sys/socket.h&gt;</code><br>
<code>#include &lt;sys/select.h&gt;</code><br>
<code>#include &lt;sys/time.h&gt;</code><br>
<code>#include &lt;netinet/in.h&gt;</code><br>
<code>#include &lt;sys/un.h&gt;</code><br>
<code>#include &lt;errno.h&gt;</code><br>
<code>#include &lt;signal.h&gt;</code><br>
<code>#include &lt;netdb.h&gt;</code><br>
<code>#include &lt;fcntl.h&gt;</code><br>
<code>#include &lt;sys/uio.h&gt;</code><br>
<code>#include &quot;VOClient.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96522681f45fae55d1e17bcb63620e45"></a><!-- doxytag: member="vocMsg.c::_VOCLIENT_LIB_" ref="96522681f45fae55d1e17bcb63620e45" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_VOCLIENT_LIB_</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="578d5b29868572f072202c1ae23ea3dd"></a><!-- doxytag: member="vocMsg.c::SELWIDTH" ref="578d5b29868572f072202c1ae23ea3dd" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SELWIDTH</b>&nbsp;&nbsp;&nbsp;32</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db119203ebbaf890a9648abbeb59ad92"></a><!-- doxytag: member="vocMsg.c::SZ_CHUNK" ref="db119203ebbaf890a9648abbeb59ad92" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SZ_CHUNK</b>&nbsp;&nbsp;&nbsp;4096</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1a1c40536cc314c339296c65d860c83"></a><!-- doxytag: member="vocMsg.c::SZ_BULKDATA" ref="d1a1c40536cc314c339296c65d860c83" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>SZ_BULKDATA</b>&nbsp;&nbsp;&nbsp;1024000</td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#a36229a2ccfb8e7a446bcf8fd66e56e5">msg_newCallMsg</a> (ObjectID objid, char *method, int nparams)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a CALL message structure initialized w/ parameters.  <a href="#a36229a2ccfb8e7a446bcf8fd66e56e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#517cadcc8f9fcdf4133f7cacf629ca4a">msg_newResultMsg</a> (int status, int type, int nitems)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a RESULT message structure initialized w/ parameters.  <a href="#517cadcc8f9fcdf4133f7cacf629ca4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#77b1550e78504576d33c763da2e0e10e">msg_newMsg</a> (char *msgclass, char *str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a MSG message initialized w/ parameters.  <a href="#77b1550e78504576d33c763da2e0e10e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#e894a9cdf87bb390cddd090447d2d644">msg_shutdownMsg</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a END message to shutdown the server.  <a href="#e894a9cdf87bb390cddd090447d2d644"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#3183a0065ee97668b3a96dff25b919c4">msg_quitMsg</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a QUIT message.  <a href="#3183a0065ee97668b3a96dff25b919c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#b97f1775026d5eaf7de3e03de6e94f1e">msg_ackMsg</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an ACK message.  <a href="#b97f1775026d5eaf7de3e03de6e94f1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocMsg_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#3cc1a4a8e24b8322ac8a2b0f6e151134">msg_noackMsg</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a NOACK message.  <a href="#3cc1a4a8e24b8322ac8a2b0f6e151134"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocRes_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#35bfd91fb870b9e42398c2c77099a486">msg_sendMsg</a> (int fd, vocMsg_t *msg)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the message to the VOClient server.  <a href="#35bfd91fb870b9e42398c2c77099a486"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#1aec8e19abd5f1741434bc0e70823965">msg_sendRawMsg</a> (int fd, vocMsg_t *msg)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the message to the VOClient server.  <a href="#1aec8e19abd5f1741434bc0e70823965"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocRes_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#c6db5a0bf755a1637562ab4a314c5468">msg_getResult</a> (int fd)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read and parse a result message.  <a href="#c6db5a0bf755a1637562ab4a314c5468"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vocRes_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#97a642f02095c629a992c67a7cc09080">msg_getResultToFile</a> (int fd, char *fname, int overwrite)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read and parse a result message, saving data to named file.  <a href="#97a642f02095c629a992c67a7cc09080"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#5fb36fa1a1b0bf447771272393e77df2">msg_addIntParam</a> (vocMsg_t *msg, int ival)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a int parameter to an outgoing CALL message.  <a href="#5fb36fa1a1b0bf447771272393e77df2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#eae320530430c840411cb1c401b88033">msg_addFloatParam</a> (vocMsg_t *msg, double dval)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a float parameter to an outgoing CALL message.  <a href="#eae320530430c840411cb1c401b88033"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#4f880a3c986d13c65b7a7d5c49c79707">msg_addStringParam</a> (vocMsg_t *msg, char *str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a string parameter to an outgoing CALL message.  <a href="#4f880a3c986d13c65b7a7d5c49c79707"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#cf6e8745c00f7d832dcfc275cf43fcf5">msg_addIntResult</a> (vocMsg_t *msg, int ival)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a integer value to a RESULT string.  <a href="#cf6e8745c00f7d832dcfc275cf43fcf5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a828295a8b60db29870c8bdb1e6922ba"></a><!-- doxytag: member="vocMsg.c::msg_addFloatResult" ref="a828295a8b60db29870c8bdb1e6922ba" args="(vocMsg_t *msg, double dval)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>msg_addFloatResult</b> (vocMsg_t *msg, double dval)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#51fb5ca640761a4e517562dee9698fff">msg_addStringResult</a> (vocMsg_t *msg, char *str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a string value to a RESULT string.  <a href="#51fb5ca640761a4e517562dee9698fff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#0d9804ce039ea71007d8d500fbf49809">msg_resultStatus</a> (vocRes_t *res)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get result status.  <a href="#0d9804ce039ea71007d8d500fbf49809"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#ec73a99da1108fa9da1a2ff97d235a36">msg_resultType</a> (vocRes_t *res)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get result type.  <a href="#ec73a99da1108fa9da1a2ff97d235a36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#8e2098c2d797fc23b8edf7886e65334c">msg_resultLength</a> (vocRes_t *res)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get result length.  <a href="#8e2098c2d797fc23b8edf7886e65334c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#44250b9b039021f88ddf37fbe5361065">msg_getIntResult</a> (vocRes_t *res, int index)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an integer result by index.  <a href="#44250b9b039021f88ddf37fbe5361065"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#b060cbd5cfe61864cc91b24080b5c2cd">msg_getFloatResult</a> (vocRes_t *res, int index)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a float result by index.  <a href="#b060cbd5cfe61864cc91b24080b5c2cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#71e1c7c95771d4e6ba986bcf6099d746">msg_getStringResult</a> (vocRes_t *res, int index)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a string result by index.  <a href="#71e1c7c95771d4e6ba986bcf6099d746"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vocMsg_8c.html#3bce32d52e40e26a9fb0bd57c48e6dbe">msg_getBuffer</a> (vocRes_t *res)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get result buffer.  <a href="#3bce32d52e40e26a9fb0bd57c48e6dbe"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8b9013ac3d6a8f93991444d8c8c5919"></a><!-- doxytag: member="vocMsg.c::vo" ref="e8b9013ac3d6a8f93991444d8c8c5919" args="" -->
VOClient *&nbsp;</td><td class="memItemRight" valign="bottom"><b>vo</b></td></tr>

</table>
<hr><h2>Detailed Description</h2>
VOCMSG.C -- VOClient Messaging Interface. This interface is used internally to communicate between the API and the VOClient Daemon.<p>
msg = newCallMsg (objid, method, nparams) msg = newResultMsg (status, type, nitems) msg = newMsg (msgclass, str)<p>
msgAddIntParam (msg, ival) msgAddFloatParam (msg, dval) msgAddStringParam (msg, str)<p>
msgAddIntResult (msg, ival) msgAddFloatResult (msg, dval) msgAddStringResult (msg, str)<p>
sendMsg (fd, msg) freeMsg (msg)<p>
res = getResult (fd) # for reading RESULT msgs freeResult (res)<p>
stat = resultStatus (res) type = resultType (res) nitems = resultLength (res)<p>
ival = getIntResult (res, index) dval = getFloatResult (res, index) str = getStringResult (res, index)<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Michael Fitzpatrick </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd>June 2006 </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="b97f1775026d5eaf7de3e03de6e94f1e"></a><!-- doxytag: member="vocMsg.c::msg_ackMsg" ref="b97f1775026d5eaf7de3e03de6e94f1e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_ackMsg           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an ACK message. 
<p>
MSG_ACKMSG -- Create an ACK message to the VOClient Server.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="eae320530430c840411cb1c401b88033"></a><!-- doxytag: member="vocMsg.c::msg_addFloatParam" ref="eae320530430c840411cb1c401b88033" args="(vocMsg_t *msg, double dval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg_addFloatParam           </td>
          <td>(</td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>dval</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a float parameter to an outgoing CALL message. 
<p>
MSG_ADDFLOATPARAM -- Add a float parameter to an outgoing CALL message. We simply append to an existing message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>outgoing message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>dval</em>&nbsp;</td><td>double value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

</div>
</div><p>
<a class="anchor" name="5fb36fa1a1b0bf447771272393e77df2"></a><!-- doxytag: member="vocMsg.c::msg_addIntParam" ref="5fb36fa1a1b0bf447771272393e77df2" args="(vocMsg_t *msg, int ival)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg_addIntParam           </td>
          <td>(</td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ival</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a int parameter to an outgoing CALL message. 
<p>
MSG_ADDINTPARAM -- Add a int parameter to an outgoing CALL message. We simply append to an existing message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>outgoing message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ival</em>&nbsp;</td><td>integer value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

</div>
</div><p>
<a class="anchor" name="cf6e8745c00f7d832dcfc275cf43fcf5"></a><!-- doxytag: member="vocMsg.c::msg_addIntResult" ref="cf6e8745c00f7d832dcfc275cf43fcf5" args="(vocMsg_t *msg, int ival)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg_addIntResult           </td>
          <td>(</td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ival</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a integer value to a RESULT string. 
<p>
MSG_ADDINTRESULT -- Add an integer value to a RESULT string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>result string </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ival</em>&nbsp;</td><td>integer value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

</div>
</div><p>
<a class="anchor" name="4f880a3c986d13c65b7a7d5c49c79707"></a><!-- doxytag: member="vocMsg.c::msg_addStringParam" ref="4f880a3c986d13c65b7a7d5c49c79707" args="(vocMsg_t *msg, char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg_addStringParam           </td>
          <td>(</td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a string parameter to an outgoing CALL message. 
<p>
MSG_ADDSTRINGPARAM -- Add a string parameter to an outgoing CALL message. We simply append to an existing message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>outgoing message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>string value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

</div>
</div><p>
<a class="anchor" name="51fb5ca640761a4e517562dee9698fff"></a><!-- doxytag: member="vocMsg.c::msg_addStringResult" ref="51fb5ca640761a4e517562dee9698fff" args="(vocMsg_t *msg, char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg_addStringResult           </td>
          <td>(</td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a string value to a RESULT string. 
<p>
MSG_ADDSTRINGRESULT -- Add a string value to a RESULT string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>result string </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>string value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

</div>
</div><p>
<a class="anchor" name="3bce32d52e40e26a9fb0bd57c48e6dbe"></a><!-- doxytag: member="vocMsg.c::msg_getBuffer" ref="3bce32d52e40e26a9fb0bd57c48e6dbe" args="(vocRes_t *res)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">len msg_getBuffer           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get result buffer. 
<p>
MSG_GETBUFFER -- Get result buffer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>res</em>&nbsp;</td><td>result message </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to result buffer </dd></dl>

</div>
</div><p>
<a class="anchor" name="b060cbd5cfe61864cc91b24080b5c2cd"></a><!-- doxytag: member="vocMsg.c::msg_getFloatResult" ref="b060cbd5cfe61864cc91b24080b5c2cd" args="(vocRes_t *res, int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">dval msg_getFloatResult           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a float result by index. 
<p>
MSG_GETFLOATRESULT -- Get a float result by index.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>res</em>&nbsp;</td><td>result message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>result index </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>float value </dd></dl>

</div>
</div><p>
<a class="anchor" name="44250b9b039021f88ddf37fbe5361065"></a><!-- doxytag: member="vocMsg.c::msg_getIntResult" ref="44250b9b039021f88ddf37fbe5361065" args="(vocRes_t *res, int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ival msg_getIntResult           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get an integer result by index. 
<p>
MSG_GETINTRESULT -- Get an integer result by index.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>res</em>&nbsp;</td><td>result message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>result index </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer value </dd></dl>

</div>
</div><p>
<a class="anchor" name="c6db5a0bf755a1637562ab4a314c5468"></a><!-- doxytag: member="vocMsg.c::msg_getResult" ref="c6db5a0bf755a1637562ab4a314c5468" args="(int fd)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">res msg_getResult           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>fd</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read and parse a result message. 
<p>
MSG_GETRESULT -- Read and parse a result message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>message channel descriptor </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>result message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="97a642f02095c629a992c67a7cc09080"></a><!-- doxytag: member="vocMsg.c::msg_getResultToFile" ref="97a642f02095c629a992c67a7cc09080" args="(int fd, char *fname, int overwrite)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">res msg_getResultToFile           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>fd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>fname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>overwrite</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read and parse a result message, saving data to named file. 
<p>
MSG_GETRESULTTOFILE -- Read and parse a result message, save bulk data to the named file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>message channel descriptor </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>result message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="71e1c7c95771d4e6ba986bcf6099d746"></a><!-- doxytag: member="vocMsg.c::msg_getStringResult" ref="71e1c7c95771d4e6ba986bcf6099d746" args="(vocRes_t *res, int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">str msg_getStringResult           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a string result by index. 
<p>
MSG_GETSTRINGRESULT -- Get a string result by index.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>res</em>&nbsp;</td><td>result message </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>result index </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string value </dd></dl>

</div>
</div><p>
<a class="anchor" name="a36229a2ccfb8e7a446bcf8fd66e56e5"></a><!-- doxytag: member="vocMsg.c::msg_newCallMsg" ref="a36229a2ccfb8e7a446bcf8fd66e56e5" args="(ObjectID objid, char *method, int nparams)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_newCallMsg           </td>
          <td>(</td>
          <td class="paramtype">ObjectID&nbsp;</td>
          <td class="paramname"> <em>objid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>method</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nparams</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a CALL message structure initialized w/ parameters. 
<p>
MSG_NEWCALLMSG -- Create a CALL message structure and initialize with the requested parameters. Structures are allocated dynamically, the caller is responsible for freeing the struct when finished.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>objid</em>&nbsp;</td><td>object id </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>method</em>&nbsp;</td><td>name of method to call </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>nparams</em>&nbsp;</td><td>number of parameters in message </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="77b1550e78504576d33c763da2e0e10e"></a><!-- doxytag: member="vocMsg.c::msg_newMsg" ref="77b1550e78504576d33c763da2e0e10e" args="(char *msgclass, char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_newMsg           </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>msgclass</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a MSG message initialized w/ parameters. 
<p>
MSG_NEWMSG -- Create a new MSG message context and initialize with the requested parameters. The caller is responsible for freeing the struct when complete.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msgclass</em>&nbsp;</td><td>message class </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>message string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="517cadcc8f9fcdf4133f7cacf629ca4a"></a><!-- doxytag: member="vocMsg.c::msg_newResultMsg" ref="517cadcc8f9fcdf4133f7cacf629ca4a" args="(int status, int type, int nitems)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_newResultMsg           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nitems</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a RESULT message structure initialized w/ parameters. 
<p>
MSG_NEWRESULTMSG -- Create a new RESULT message context and initialize with the requested parameters. The caller is responsible for freeing the struct when complete.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>status</em>&nbsp;</td><td>result status </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>result type </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>nitems</em>&nbsp;</td><td>number of items in message </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="3cc1a4a8e24b8322ac8a2b0f6e151134"></a><!-- doxytag: member="vocMsg.c::msg_noackMsg" ref="3cc1a4a8e24b8322ac8a2b0f6e151134" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_noackMsg           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a NOACK message. 
<p>
MSG_NOACKMSG -- Create an NO-ACK message to the VOClient Server.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="3183a0065ee97668b3a96dff25b919c4"></a><!-- doxytag: member="vocMsg.c::msg_quitMsg" ref="3183a0065ee97668b3a96dff25b919c4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_quitMsg           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a QUIT message. 
<p>
MSG_QUITMSG -- Create a QUIT message to the VOClient Server to tell it we're leaving but that it should keep running<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="8e2098c2d797fc23b8edf7886e65334c"></a><!-- doxytag: member="vocMsg.c::msg_resultLength" ref="8e2098c2d797fc23b8edf7886e65334c" args="(vocRes_t *res)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">len msg_resultLength           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get result length. 
<p>
MSG_RESULTLENGTH -- Get result length.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>result string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>result length </dd></dl>

</div>
</div><p>
<a class="anchor" name="0d9804ce039ea71007d8d500fbf49809"></a><!-- doxytag: member="vocMsg.c::msg_resultStatus" ref="0d9804ce039ea71007d8d500fbf49809" args="(vocRes_t *res)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">status msg_resultStatus           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get result status. 
<p>
MSG_RESULTSTATUS -- Get result status.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>result string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>result status </dd></dl>

</div>
</div><p>
<a class="anchor" name="ec73a99da1108fa9da1a2ff97d235a36"></a><!-- doxytag: member="vocMsg.c::msg_resultType" ref="ec73a99da1108fa9da1a2ff97d235a36" args="(vocRes_t *res)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">type msg_resultType           </td>
          <td>(</td>
          <td class="paramtype">vocRes_t *&nbsp;</td>
          <td class="paramname"> <em>res</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get result type. 
<p>
MSG_RESULTTYPE -- Get result type.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>result string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>result type </dd></dl>

</div>
</div><p>
<a class="anchor" name="35bfd91fb870b9e42398c2c77099a486"></a><!-- doxytag: member="vocMsg.c::msg_sendMsg" ref="35bfd91fb870b9e42398c2c77099a486" args="(int fd, vocMsg_t *msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_sendMsg           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>fd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Send the message to the VOClient server. 
<p>
MSG_SENDMSG -- Send the message to the VOClient Server and wait for the ACK. The simple form of the message returns the result handle, for the raw message we only send to allow to a bullk return object.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>message channel descriptor </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>message string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="1aec8e19abd5f1741434bc0e70823965"></a><!-- doxytag: member="vocMsg.c::msg_sendRawMsg" ref="1aec8e19abd5f1741434bc0e70823965" args="(int fd, vocMsg_t *msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">len msg_sendRawMsg           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>fd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vocMsg_t *&nbsp;</td>
          <td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Send the message to the VOClient server. 
<p>
MSG_SENDRAWMSG -- Send the message to the VOClient Server.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>message channel descriptor </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>message string </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
<a class="anchor" name="e894a9cdf87bb390cddd090447d2d644"></a><!-- doxytag: member="vocMsg.c::msg_shutdownMsg" ref="e894a9cdf87bb390cddd090447d2d644" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">msg msg_shutdownMsg           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a END message to shutdown the server. 
<p>
MSG_SHUTDOWNMSG -- Create an END message to the VOClient Server to shut it down.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new message object </dd></dl>

</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:08:58 2013 for VOClient API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>