-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassZmqMessage_1_1Outgoing.html
More file actions
363 lines (328 loc) · 20 KB
/
classZmqMessage_1_1Outgoing.html
File metadata and controls
363 lines (328 loc) · 20 KB
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
<html>
<head>
<meta name="keywords" content="0MQ, ZeroMQ, C++, multipart, message, library, open source, ZmqMessage" />
<meta name="description" content="ZmqMessage is free open source C++ library for sending and receiving ZeroMQ multipart messages"/>
<meta name="google-site-verification" content="0EvtpfjffSrc0fDV9ubKQVfq3IV55KY5d59hXHg9M34" />
<title>ZmqMessage: ZmqMessage::Outgoing< RoutingPolicy > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style>
/* must override a few items to get the style background color */
</style>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-25607292-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<table class="zm_headbar">
<tr>
<td>
<span><a href="index.html">Overview</a></span>
<span><a href="zm_tutorial.html">Tutorial</a></span>
<span><a href="namespaceZmqMessage.html">API reference</a></span>
<span><a href="examples.html">Examples</a></span>
<span><a href="zm_build.html">Build</a></span>
<span><a href="https://github.com/zmqmessage/zmqmessage/">Download</a></span>
</td>
<td align="right" class="zm_greynote">ZmqMessage 0.1 - 21 Oct 2011</td>
</tr></table>
<hr style="height: 3px;">
<!-- Generated by Doxygen 1.4.7 -->
<div class="nav">
<a class="el" href="namespaceZmqMessage.html">ZmqMessage</a>::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a></div>
<h1>ZmqMessage::Outgoing< RoutingPolicy > Class Template Reference</h1><!-- doxytag: class="ZmqMessage::Outgoing" --><!-- doxytag: inherits="ZmqMessage::Sink" -->Represents outgoing message to be sent.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ZmqMessage_8hpp-source.html">ZmqMessage.hpp</a>></code>
<p>
<p>Inheritance diagram for ZmqMessage::Outgoing< RoutingPolicy >:
<p><center><img src="classZmqMessage_1_1Outgoing.png" usemap="#ZmqMessage::Outgoing< RoutingPolicy >_map" border="0" alt=""></center>
<map name="ZmqMessage::Outgoing< RoutingPolicy >_map">
<area href="classZmqMessage_1_1Sink.html" alt="ZmqMessage::Sink" shape="rect" coords="0,56,245,80">
<area href="classZmqMessage_1_1Private_1_1NonCopyable.html" alt="ZmqMessage::Private::NonCopyable" shape="rect" coords="0,0,245,24">
</map>
<a href="classZmqMessage_1_1Outgoing-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef RoutingPolicy </td><td class="memItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#f1ce936290f84edb2a8c68aeddfa2cce">RoutingPolicyType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#c2653be258531490363e273315ce0f8b">Outgoing</a> (zmq::socket_t &dst, unsigned options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#666ce57093d96b85e3058499cc9aa3d6">Outgoing</a> (<a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> out_opts)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<typename InRoutingPolicy> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#aa553a06b6d8670618a1fc92619580da">Outgoing</a> (zmq::socket_t &dst, <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a>< InRoutingPolicy > &incoming, unsigned options) throw (ZmqErrorType)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<typename InRoutingPolicy> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#244ad191d421807cd90df972e2fa7735">Outgoing</a> (<a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> out_opts, <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a>< InRoutingPolicy > &incoming) throw (ZmqErrorType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#bbe128d1332d38178ee7448454543dce">Outgoing</a> (zmq::socket_t &dst, <a class="el" href="classZmqMessage_1_1Multipart.html">Multipart</a> &incoming, unsigned options) throw (ZmqErrorType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#ef7db71d6ec9c831c026ba47ef6c4cc5">Outgoing</a> (<a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> out_opts, <a class="el" href="classZmqMessage_1_1Multipart.html">Multipart</a> &incoming) throw (ZmqErrorType)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#7aab41ff1fe428089490703679aaf541">send_routing</a> (<a class="el" href="namespaceZmqMessage.html#3e8a62abe56d5a8ff7bb2e8921f9e704">MsgPtrVec</a> *routing) throw(ZmqErrorType)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classZmqMessage_1_1Outgoing.html#596f212912b356527e69f6fed560546d">send_routing</a> (<a class="el" href="namespaceZmqMessage.html#3e8a62abe56d5a8ff7bb2e8921f9e704">MsgPtrVec</a> *routing) throw(ZmqErrorType)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class RoutingPolicy><br>
class ZmqMessage::Outgoing< RoutingPolicy ></h3>
Represents outgoing message to be sent.
<p>
All message parts are either sent (if possible) OR become exclusively owned by this object, if sending of parts immediately would block and <a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> created with <a class="el" href="structZmqMessage_1_1OutOptions.html#ada297235a6adb7dc637eab6e8cbe1b3">OutOptions.NONBLOCK</a> and <a class="el" href="structZmqMessage_1_1OutOptions.html#adc74d66130c3ba01e9b74ca425d168b">OutOptions.CACHE_ON_BLOCK</a>. That <a class="el" href="classZmqMessage_1_1Multipart.html">Multipart</a> is detachable (ownership may be yielded, see <code><a class="el" href="classZmqMessage_1_1Sink.html#59f9d277f528a97ad1eb2df45786b730">detach()</a></code> method). <a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> message may be linked with corresponding incoming message (when <code><a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a></code> reference given to constructor). In this case the ownership of message parts may be transferred from incoming to outgoing message (by <code>operator <<</code> on message_t), to avoid copying. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="zasync_8cpp-example.html#_a12">zasync.cpp</a>, <a class="el" href="zbisort_8cpp-example.html#_a34">zbisort.cpp</a>, <a class="el" href="zqueue_8cpp-example.html#_a46">zqueue.cpp</a>, <a class="el" href="zserialize_8cpp-example.html#_a66">zserialize.cpp</a>, and <a class="el" href="zsort_8cpp-example.html#_a70">zsort.cpp</a>.</dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="f1ce936290f84edb2a8c68aeddfa2cce"></a><!-- doxytag: member="ZmqMessage::Outgoing::RoutingPolicyType" ref="f1ce936290f84edb2a8c68aeddfa2cce" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname">typedef RoutingPolicy <a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html#f1ce936290f84edb2a8c68aeddfa2cce">RoutingPolicyType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Routing policy used for sending multipart message
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c2653be258531490363e273315ce0f8b"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="c2653be258531490363e273315ce0f8b" args="(zmq::socket_t &dst, unsigned options)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype">zmq::socket_t & </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="666ce57093d96b85e3058499cc9aa3d6"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="666ce57093d96b85e3058499cc9aa3d6" args="(OutOptions out_opts)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> </td>
<td class="paramname"> <em>out_opts</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="aa553a06b6d8670618a1fc92619580da"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="aa553a06b6d8670618a1fc92619580da" args="(zmq::socket_t &dst, Incoming< InRoutingPolicy > &incoming, unsigned options)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<div class="memtemplate">
template<typename InRoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype">zmq::socket_t & </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a>< InRoutingPolicy > & </td>
<td class="paramname"> <em>incoming</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> throw (<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> message is a response to the given <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a> message, so we resend Incoming's routing first.
</div>
</div><p>
<a class="anchor" name="244ad191d421807cd90df972e2fa7735"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="244ad191d421807cd90df972e2fa7735" args="(OutOptions out_opts, Incoming< InRoutingPolicy > &incoming)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<div class="memtemplate">
template<typename InRoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> </td>
<td class="paramname"> <em>out_opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a>< InRoutingPolicy > & </td>
<td class="paramname"> <em>incoming</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> throw (<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> message is a response to the given <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a> message, so we resend Incoming's routing first.
</div>
</div><p>
<a class="anchor" name="bbe128d1332d38178ee7448454543dce"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="bbe128d1332d38178ee7448454543dce" args="(zmq::socket_t &dst, Multipart &incoming, unsigned options)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype">zmq::socket_t & </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZmqMessage_1_1Multipart.html">Multipart</a> & </td>
<td class="paramname"> <em>incoming</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> throw (<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> message is NOT a response to the given <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a> message, so we send normal routing.
</div>
</div><p>
<a class="anchor" name="ef7db71d6ec9c831c026ba47ef6c4cc5"></a><!-- doxytag: member="ZmqMessage::Outgoing::Outgoing" ref="ef7db71d6ec9c831c026ba47ef6c4cc5" args="(OutOptions out_opts, Multipart &incoming)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class RoutingPolicy> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< RoutingPolicy >::<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structZmqMessage_1_1OutOptions.html">OutOptions</a> </td>
<td class="paramname"> <em>out_opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZmqMessage_1_1Multipart.html">Multipart</a> & </td>
<td class="paramname"> <em>incoming</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> throw (<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classZmqMessage_1_1Outgoing.html">Outgoing</a> message is NOT a response to the given <a class="el" href="classZmqMessage_1_1Incoming.html">Incoming</a> message, so we send normal routing.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="596f212912b356527e69f6fed560546d"></a><!-- doxytag: member="ZmqMessage::Outgoing::send_routing" ref="596f212912b356527e69f6fed560546d" args="(MsgPtrVec *routing)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< <a class="el" href="classZmqMessage_1_1XRouting.html">XRouting</a> >::send_routing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceZmqMessage.html#3e8a62abe56d5a8ff7bb2e8921f9e704">MsgPtrVec</a> * </td>
<td class="paramname"> <em>routing</em> </td>
<td> ) </td>
<td width="100%"> throw(<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7aab41ff1fe428089490703679aaf541"></a><!-- doxytag: member="ZmqMessage::Outgoing::send_routing" ref="7aab41ff1fe428089490703679aaf541" args="(MsgPtrVec *routing)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classZmqMessage_1_1Outgoing.html">ZmqMessage::Outgoing</a>< <a class="el" href="classZmqMessage_1_1SimpleRouting.html">SimpleRouting</a> >::send_routing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceZmqMessage.html#3e8a62abe56d5a8ff7bb2e8921f9e704">MsgPtrVec</a> * </td>
<td class="paramname"> <em>routing</em> </td>
<td> ) </td>
<td width="100%"> throw(<a class="el" href="namespaceZmqMessage.html#b6d56fe86e2309d7182d41d2e0f3c76a">ZmqErrorType</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>include/<a class="el" href="ZmqMessage_8hpp-source.html">ZmqMessage.hpp</a></ul>
<hr style="height: 3px;">
<div class="zm_greynote">
ZmqMessage 0.1 — open source software, <a href="mailto:support@zmqmessage.org">support@zmqmessage.org</a>
</div>
</body>
</html>