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
|
<!--
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>qpid::client::FailoverListener 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="a00574.html">qpid</a> </li>
<li class="navelem"><a class="el" href="a00576.html">client</a> </li>
<li class="navelem"><a class="el" href="a00118.html">FailoverListener</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pri-types">Private Types</a> |
<a href="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<div class="title">qpid::client::FailoverListener Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="qpid::client::FailoverListener" --><!-- doxytag: inherits="qpid::client::MessageListener,qpid::sys::Runnable" -->
<p>Listen for updates from the amq.failover exchange.
<a href="a00118.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00464_source.html">qpid/client/FailoverListener.h</a>></code></p>
<p><a href="a00680.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="a00118.html#a68b519623a0a4d3b17cae8261164980d">FailoverListener</a> (<a class="el" href="a00058.html">Connection</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to amq.failover exchange. <a href="#a68b519623a0a4d3b17cae8261164980d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00118.html#a99ee8bbe5c3d95a7ff7e633f25824832">FailoverListener</a> (<a class="el" href="a00058.html">Connection</a>, bool useInitial)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to amq.failover exchange. <a href="#a99ee8bbe5c3d95a7ff7e633f25824832"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00118.html#ae1ab635dbb52e5db8c230d8f6d683ae8">~FailoverListener</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00118.html#ab02a17be815ff38783b0f539f3cc16b4">getKnownBrokers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the latest list of known broker URLs. <a href="#ab02a17be815ff38783b0f539f3cc16b4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00118.html#a882650870f3aef8515fb79116fd4183e">getKnownBrokers</a> (const <a class="el" href="a00206.html">Message</a> &m)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the broker list from a failover exchange message. <a href="#a882650870f3aef8515fb79116fd4183e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00345.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00118.html#ae7881f50027f0f303b9b3ff070bc5728">AMQ_FAILOVER</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the standard failover exchange amq.failover. <a href="#ae7881f50027f0f303b9b3ff070bc5728"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef boost::function0< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00293.html#ae6dd30caad64962b36e826fb505cc626">Functor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type to represent a runnable as a Functor. <a href="#ae6dd30caad64962b36e826fb505cc626"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00293.html#ae6dd30caad64962b36e826fb505cc626">Functor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00293.html#ac0af11e62e346d8295ddb9ee40620eb0">functor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a functor object that will call this-><a class="el" href="a00293.html#a8c8296f61a69c142ad7afecca2578ea1" title="Derived classes override run().">run()</a>. <a href="#ac0af11e62e346d8295ddb9ee40620eb0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Listen for updates from the amq.failover exchange. </p>
<p>In a cluster, the amq.failover exchange provides updates whenever the cluster membership changes. This class subscribes to the failover exchange and providees the latest list of known brokers.</p>
<p>You can also subscribe to amq.failover yourself and use FailoverListener::decode to extract a list of broker URLs from a failover exchange message. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a68b519623a0a4d3b17cae8261164980d"></a><!-- doxytag: member="qpid::client::FailoverListener::FailoverListener" ref="a68b519623a0a4d3b17cae8261164980d" args="(Connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qpid::client::FailoverListener::FailoverListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00058.html">Connection</a> </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribe to amq.failover exchange. </p>
</div>
</div>
<a class="anchor" id="a99ee8bbe5c3d95a7ff7e633f25824832"></a><!-- doxytag: member="qpid::client::FailoverListener::FailoverListener" ref="a99ee8bbe5c3d95a7ff7e633f25824832" args="(Connection, bool useInitial)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qpid::client::FailoverListener::FailoverListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00058.html">Connection</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useInitial</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribe to amq.failover exchange. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">useInitial</td><td>If true use the connection's initial brokers as the initial value of getKnownBrokers </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae1ab635dbb52e5db8c230d8f6d683ae8"></a><!-- doxytag: member="qpid::client::FailoverListener::~FailoverListener" ref="ae1ab635dbb52e5db8c230d8f6d683ae8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qpid::client::FailoverListener::~FailoverListener </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="a882650870f3aef8515fb79116fd4183e"></a><!-- doxytag: member="qpid::client::FailoverListener::getKnownBrokers" ref="a882650870f3aef8515fb79116fd4183e" args="(const Message &m)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00386.html">std::vector</a><<a class="el" href="a00373.html">Url</a>> qpid::client::FailoverListener::getKnownBrokers </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00206.html">Message</a> & </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract the broker list from a failover exchange message. </p>
</div>
</div>
<a class="anchor" id="ab02a17be815ff38783b0f539f3cc16b4"></a><!-- doxytag: member="qpid::client::FailoverListener::getKnownBrokers" ref="ab02a17be815ff38783b0f539f3cc16b4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00386.html">std::vector</a><<a class="el" href="a00373.html">Url</a>> qpid::client::FailoverListener::getKnownBrokers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the latest list of known broker URLs. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae7881f50027f0f303b9b3ff070bc5728"></a><!-- doxytag: member="qpid::client::FailoverListener::AMQ_FAILOVER" ref="ae7881f50027f0f303b9b3ff070bc5728" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00345.html">std::string</a> <a class="el" href="a00118.html#ae7881f50027f0f303b9b3ff070bc5728">qpid::client::FailoverListener::AMQ_FAILOVER</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the standard failover exchange amq.failover. </p>
<p>Definition at line <a class="el" href="a00464_source.html#l00055">55</a> of file <a class="el" href="a00464_source.html">FailoverListener.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>qpid/client/<a class="el" href="a00464_source.html">FailoverListener.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>
|
