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
|
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>qmf::engine::Agent Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#FFFFFF">
<table border="0" width="90%" align="center">
<tr>
<td align="left">
<a title="Apache Qpid Project Page" href="http://qpid.apache.org">Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET</a>
</td>
<td align="right">
<a title="Apache Qpid Documentation" href="http://qpid.apache.org/documentation.html">Apache Qpid Documentation</a>
</td>
</tr>
</table>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00571.html">qmf</a> </li>
<li class="navelem"><a class="el" href="a00572.html">engine</a> </li>
<li class="navelem"><a class="el" href="a00005.html">Agent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">qmf::engine::Agent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="qmf::engine::Agent" -->
<p><a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> - Protocol engine for the QMF agent.
<a href="a00005.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00404_source.html">qmf/engine/Agent.h</a>></code></p>
<p><a href="a00619.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a44efc142d9c889bb9640cee573cc19fc">Agent</a> (char *label, bool internalStore=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a4939abdaa0d08dbf23100000d22b3f22">~Agent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a481ccd6a73ced7d1a8e524350f2f09e9">setStoreDir</a> (const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure the directory path for storing persistent data. <a href="#a481ccd6a73ced7d1a8e524350f2f09e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a489c88f95a56dbf716abaa4b30beda6e">setTransferDir</a> (const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure the directory path for files transferred over QMF. <a href="#a489c88f95a56dbf716abaa4b30beda6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#ac3884711b7deb275ade4c29fff567bee">handleRcvMessage</a> (<a class="el" href="a00207.html">Message</a> &message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pass messages received from the AMQP session to the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> engine. <a href="#ac3884711b7deb275ade4c29fff567bee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#acc8b2035af16616624247263ed3ec5ce">getXmtMessage</a> (<a class="el" href="a00207.html">Message</a> &item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next message to be sent to the AMQP network. <a href="#acc8b2035af16616624247263ed3ec5ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#aafcde4dd6ea395e5b9f8200310c6d03b">popXmt</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove and discard one message from the head of the transmit queue. <a href="#aafcde4dd6ea395e5b9f8200310c6d03b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a15c19f43b28f63a826562d1a1dabd7e7">getEvent</a> (<a class="el" href="a00010.html">AgentEvent</a> &event) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next application event from the agent engine. <a href="#a15c19f43b28f63a826562d1a1dabd7e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a85425603a2456369632069399a29f5fc">popEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove and discard one event from the head of the event queue. <a href="#a85425603a2456369632069399a29f5fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a126d7a08de068af40544a207b1e5c15f">newSession</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A new AMQP session has been established for <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> communication. <a href="#a126d7a08de068af40544a207b1e5c15f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a5e693ba92e2dcc74b6b2ce181f0be34f">startProtocol</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the QMF <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> protocol. <a href="#a5e693ba92e2dcc74b6b2ce181f0be34f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a4796c9caa8b20c770ec4c439f9c03ad2">heartbeat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called periodically so the agent can supply a heartbeat. <a href="#a4796c9caa8b20c770ec4c439f9c03ad2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a1df18fdb59e5f9ed134e90ea65b130f5">methodResponse</a> (<a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> sequence, <a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> status, char *text, const <a class="el" href="a00379.html">Value</a> &arguments)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Respond to a method request. <a href="#a1df18fdb59e5f9ed134e90ea65b130f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a069c7ade6ea8606dbb6d5cfb6c3eca63">queryResponse</a> (<a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> sequence, <a class="el" href="a00233.html">Object</a> &object, bool prop=true, bool stat=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a content indication to the QMF bus. <a href="#a069c7ade6ea8606dbb6d5cfb6c3eca63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#abb5d659981b2e6bde14d7fe4dcd38d75">queryComplete</a> (<a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> sequence)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicate the completion of a query. <a href="#abb5d659981b2e6bde14d7fe4dcd38d75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a9e1adfb2d9558d344df9eb266f961f9b">registerClass</a> (<a class="el" href="a00306.html">SchemaObjectClass</a> *cls)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a schema class with the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a>. <a href="#a9e1adfb2d9558d344df9eb266f961f9b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a550d3e7de8f0dfbdd5f0c5b396d263f0">registerClass</a> (<a class="el" href="a00301.html">SchemaEventClass</a> *cls)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a schema class with the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a>. <a href="#a550d3e7de8f0dfbdd5f0c5b396d263f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00236.html">ObjectId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#adb7f72867b184e94f16a0c7c8df10f20">addObject</a> (<a class="el" href="a00233.html">Object</a> &obj, uint64_t persistId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Give an object to the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> for storage and management. <a href="#adb7f72867b184e94f16a0c7c8df10f20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00236.html">ObjectId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a7ed1a242f908bb3288fcd7e2050a8a12">allocObjectId</a> (uint64_t persistId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate an object-id for an object that will be managed by the application. <a href="#a7ed1a242f908bb3288fcd7e2050a8a12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00236.html">ObjectId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a3e4807d2e66cfcb85fad189e49625df3">allocObjectId</a> (<a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> persistIdLo, <a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> persistIdHi)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a439626a88dad21ae5395a06f2dade862">raiseEvent</a> (<a class="el" href="a00108.html">Event</a> &event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Raise an event into the QMF network. <a href="#a439626a88dad21ae5395a06f2dade862"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> - Protocol engine for the QMF agent. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a44efc142d9c889bb9640cee573cc19fc"></a><!-- doxytag: member="qmf::engine::Agent::Agent" ref="a44efc142d9c889bb9640cee573cc19fc" args="(char *label, bool internalStore=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qmf::engine::Agent::Agent </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>internalStore</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4939abdaa0d08dbf23100000d22b3f22"></a><!-- doxytag: member="qmf::engine::Agent::~Agent" ref="a4939abdaa0d08dbf23100000d22b3f22" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qmf::engine::Agent::~Agent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adb7f72867b184e94f16a0c7c8df10f20"></a><!-- doxytag: member="qmf::engine::Agent::addObject" ref="adb7f72867b184e94f16a0c7c8df10f20" args="(Object &obj, uint64_t persistId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00236.html">ObjectId</a>* qmf::engine::Agent::addObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00233.html">Object</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>persistId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Give an object to the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> for storage and management. </p>
<p>Once added, the agent takes responsibility for the life cycle of the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>The object to be managed by the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a>. </td></tr>
<tr><td class="paramname">persistId</td><td>A unique non-zero value if the object-id is to be persistent. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The objectId of the managed object. </dd></dl>
</div>
</div>
<a class="anchor" id="a7ed1a242f908bb3288fcd7e2050a8a12"></a><!-- doxytag: member="qmf::engine::Agent::allocObjectId" ref="a7ed1a242f908bb3288fcd7e2050a8a12" args="(uint64_t persistId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00236.html">ObjectId</a>* qmf::engine::Agent::allocObjectId </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>persistId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate an object-id for an object that will be managed by the application. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">persistId</td><td>A unique non-zero value if the object-id is to be persistent. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The objectId structure for the allocated ID. </dd></dl>
</div>
</div>
<a class="anchor" id="a3e4807d2e66cfcb85fad189e49625df3"></a><!-- doxytag: member="qmf::engine::Agent::allocObjectId" ref="a3e4807d2e66cfcb85fad189e49625df3" args="(uint32_t persistIdLo, uint32_t persistIdHi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00236.html">ObjectId</a>* qmf::engine::Agent::allocObjectId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>persistIdLo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>persistIdHi</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a15c19f43b28f63a826562d1a1dabd7e7"></a><!-- doxytag: member="qmf::engine::Agent::getEvent" ref="a15c19f43b28f63a826562d1a1dabd7e7" args="(AgentEvent &event) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool qmf::engine::Agent::getEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00010.html">AgentEvent</a> & </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next application event from the agent engine. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The event iff the return value is true </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if event is valid, false if there are no events to process </dd></dl>
</div>
</div>
<a class="anchor" id="acc8b2035af16616624247263ed3ec5ce"></a><!-- doxytag: member="qmf::engine::Agent::getXmtMessage" ref="acc8b2035af16616624247263ed3ec5ce" args="(Message &item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool qmf::engine::Agent::getXmtMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00207.html">Message</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next message to be sent to the AMQP network. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>The <a class="el" href="a00207.html">Message</a> structure describing the message to be produced. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="a00207.html">Message</a> is valid, false if there are no messages to send. </dd></dl>
</div>
</div>
<a class="anchor" id="ac3884711b7deb275ade4c29fff567bee"></a><!-- doxytag: member="qmf::engine::Agent::handleRcvMessage" ref="ac3884711b7deb275ade4c29fff567bee" args="(Message &message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::handleRcvMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00207.html">Message</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pass messages received from the AMQP session to the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> engine. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>AMQP messages received on the agent session. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4796c9caa8b20c770ec4c439f9c03ad2"></a><!-- doxytag: member="qmf::engine::Agent::heartbeat" ref="a4796c9caa8b20c770ec4c439f9c03ad2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::heartbeat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called periodically so the agent can supply a heartbeat. </p>
</div>
</div>
<a class="anchor" id="a1df18fdb59e5f9ed134e90ea65b130f5"></a><!-- doxytag: member="qmf::engine::Agent::methodResponse" ref="a1df18fdb59e5f9ed134e90ea65b130f5" args="(uint32_t sequence, uint32_t status, char *text, const Value &arguments)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::methodResponse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>sequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00379.html">Value</a> & </td>
<td class="paramname"><em>arguments</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Respond to a method request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sequence</td><td>The sequence number from the method request event. </td></tr>
<tr><td class="paramname">status</td><td>The method's completion status. </td></tr>
<tr><td class="paramname">text</td><td>Status text ("OK" or an error message) </td></tr>
<tr><td class="paramname">arguments</td><td>The list of output arguments from the method call. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a126d7a08de068af40544a207b1e5c15f"></a><!-- doxytag: member="qmf::engine::Agent::newSession" ref="a126d7a08de068af40544a207b1e5c15f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::newSession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A new AMQP session has been established for <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> communication. </p>
</div>
</div>
<a class="anchor" id="a85425603a2456369632069399a29f5fc"></a><!-- doxytag: member="qmf::engine::Agent::popEvent" ref="a85425603a2456369632069399a29f5fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::popEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove and discard one event from the head of the event queue. </p>
</div>
</div>
<a class="anchor" id="aafcde4dd6ea395e5b9f8200310c6d03b"></a><!-- doxytag: member="qmf::engine::Agent::popXmt" ref="aafcde4dd6ea395e5b9f8200310c6d03b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::popXmt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove and discard one message from the head of the transmit queue. </p>
</div>
</div>
<a class="anchor" id="abb5d659981b2e6bde14d7fe4dcd38d75"></a><!-- doxytag: member="qmf::engine::Agent::queryComplete" ref="abb5d659981b2e6bde14d7fe4dcd38d75" args="(uint32_t sequence)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::queryComplete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>sequence</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicate the completion of a query. </p>
<p>This is not used for SYNC_START requests. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sequence</td><td>The sequence number of the GET request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a069c7ade6ea8606dbb6d5cfb6c3eca63"></a><!-- doxytag: member="qmf::engine::Agent::queryResponse" ref="a069c7ade6ea8606dbb6d5cfb6c3eca63" args="(uint32_t sequence, Object &object, bool prop=true, bool stat=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::queryResponse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"><em>sequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00233.html">Object</a> & </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>prop</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>stat</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a content indication to the QMF bus. </p>
<p>This is only needed for objects that are managed by the application. This is *NOT* needed for objects managed by the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> (inserted using addObject). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sequence</td><td>The sequence number of the GET request or the SYNC_START request. </td></tr>
<tr><td class="paramname">object</td><td>The object (annotated with "changed" flags) for publication. </td></tr>
<tr><td class="paramname">prop</td><td>If true, changed object properties are transmitted. </td></tr>
<tr><td class="paramname">stat</td><td>If true, changed object statistics are transmitted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a439626a88dad21ae5395a06f2dade862"></a><!-- doxytag: member="qmf::engine::Agent::raiseEvent" ref="a439626a88dad21ae5395a06f2dade862" args="(Event &event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::raiseEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00108.html">Event</a> & </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Raise an event into the QMF network. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The event object for the event to be raised. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9e1adfb2d9558d344df9eb266f961f9b"></a><!-- doxytag: member="qmf::engine::Agent::registerClass" ref="a9e1adfb2d9558d344df9eb266f961f9b" args="(SchemaObjectClass *cls)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::registerClass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00306.html">SchemaObjectClass</a> * </td>
<td class="paramname"><em>cls</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a schema class with the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cls</td><td>A SchemaObejctClass object that defines data managed by the agent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a550d3e7de8f0dfbdd5f0c5b396d263f0"></a><!-- doxytag: member="qmf::engine::Agent::registerClass" ref="a550d3e7de8f0dfbdd5f0c5b396d263f0" args="(SchemaEventClass *cls)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::registerClass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00301.html">SchemaEventClass</a> * </td>
<td class="paramname"><em>cls</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a schema class with the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cls</td><td>A <a class="el" href="a00301.html">SchemaEventClass</a> object that defines events sent by the agent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a481ccd6a73ced7d1a8e524350f2f09e9"></a><!-- doxytag: member="qmf::engine::Agent::setStoreDir" ref="a481ccd6a73ced7d1a8e524350f2f09e9" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::setStoreDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configure the directory path for storing persistent data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Null-terminated string containing a directory path where files can be created, written, and read. If NULL, no persistent storage will be attempted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a489c88f95a56dbf716abaa4b30beda6e"></a><!-- doxytag: member="qmf::engine::Agent::setTransferDir" ref="a489c88f95a56dbf716abaa4b30beda6e" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::setTransferDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configure the directory path for files transferred over QMF. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Null-terminated string containing a directory path where files can be created, deleted, written, and read. If NULL, file transfers shall not be permitted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5e693ba92e2dcc74b6b2ce181f0be34f"></a><!-- doxytag: member="qmf::engine::Agent::startProtocol" ref="a5e693ba92e2dcc74b6b2ce181f0be34f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qmf::engine::Agent::startProtocol </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start the QMF <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> protocol. </p>
<p>This should be invoked after a SETUP_COMPLETE event is received from the <a class="el" href="a00005.html" title="Agent - Protocol engine for the QMF agent.">Agent</a> engine. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>qmf/engine/<a class="el" href="a00404_source.html">Agent.h</a></li>
</ul>
</div>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<hr size="1">
<address style="text-align: left;"><small>
Qpid C++ API Reference</small></address>
<address style="text-align: right;">
<small>
Generated on Thu May 10 2012 for Qpid C++ Client API by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5</small>
</address>
</body>
</html>
|
