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
|
<!--
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::FailoverManager 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="a00119.html">FailoverManager</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">qpid::client::FailoverManager Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="qpid::client::FailoverManager" -->
<p>Utility to manage failover.
<a href="a00119.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00465_source.html">qpid/client/FailoverManager.h</a>></code></p>
<p><a href="a00682.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html">Command</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interface to implement for doing work that can be resumed on failover. <a href="a00051.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00273.html">ReconnectionStrategy</a></td></tr>
<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="a00119.html#ae0c259b14b780faa344fde59e957abee">FailoverManager</a> (const <a class="el" href="a00065.html">ConnectionSettings</a> &settings, <a class="el" href="a00273.html">ReconnectionStrategy</a> *strategy=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a manager to control failover for a logical connection. <a href="#ae0c259b14b780faa344fde59e957abee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00058.html">Connection</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a6d3e7cbd9fd9263f274e492743a29c72">connect</a> (<a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> > brokers=<a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> >())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current connection if open or attept to reconnect to the specified list of urls. <a href="#a6d3e7cbd9fd9263f274e492743a29c72"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00058.html">Connection</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ad5db4f3c25d41830ac1c3b28f771b5fe">getConnection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current connection whether open or not. <a href="#ad5db4f3c25d41830ac1c3b28f771b5fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a33215cb636cd3446d407848a8f15c95a">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the current connection. <a href="#a33215cb636cd3446d407848a8f15c95a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a3df5cecbae290c75e121d5ed45811013">execute</a> (<a class="el" href="a00051.html">Command</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reliably execute the specified command. <a href="#a3df5cecbae290c75e121d5ed45811013"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Utility to manage failover. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae0c259b14b780faa344fde59e957abee"></a><!-- doxytag: member="qpid::client::FailoverManager::FailoverManager" ref="ae0c259b14b780faa344fde59e957abee" args="(const ConnectionSettings &settings, ReconnectionStrategy *strategy=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qpid::client::FailoverManager::FailoverManager </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00065.html">ConnectionSettings</a> & </td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00273.html">ReconnectionStrategy</a> * </td>
<td class="paramname"><em>strategy</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a manager to control failover for a logical connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>the initial connection settings </td></tr>
<tr><td class="paramname">strategy</td><td>optional stratgey callback allowing application to edit or reorder the list of urls to which reconnection is attempted </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a33215cb636cd3446d407848a8f15c95a"></a><!-- doxytag: member="qpid::client::FailoverManager::close" ref="a33215cb636cd3446d407848a8f15c95a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::client::FailoverManager::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the current connection. </p>
</div>
</div>
<a class="anchor" id="a6d3e7cbd9fd9263f274e492743a29c72"></a><!-- doxytag: member="qpid::client::FailoverManager::connect" ref="a6d3e7cbd9fd9263f274e492743a29c72" args="(std::vector< Url > brokers=std::vector< Url >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00058.html">Connection</a>& qpid::client::FailoverManager::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> > </td>
<td class="paramname"><em>brokers</em> = <code><a class="el" href="a00386.html">std::vector</a>< <a class="el" href="a00373.html">Url</a> >()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current connection if open or attept to reconnect to the specified list of urls. </p>
<p>If no list is specified the list of known brokers from the last connection will be used. If no list is specified and this is the first connect attempt, the host and port from the initial settings will be used.</p>
<p>If the full list is tried and all attempts fail, <a class="el" href="a00047.html">CannotConnectException</a> is thrown. </p>
</div>
</div>
<a class="anchor" id="a3df5cecbae290c75e121d5ed45811013"></a><!-- doxytag: member="qpid::client::FailoverManager::execute" ref="a3df5cecbae290c75e121d5ed45811013" args="(Command &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qpid::client::FailoverManager::execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00051.html">Command</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reliably execute the specified command. </p>
<p>This involves creating a session on which to carry out the work of the command, handling failover occuring while exeuting that command and re-starting the work.</p>
<p>Multiple concurrent threads can call execute with different commands; each thread will be allocated its own session. <a class="el" href="a00119.html" title="Utility to manage failover.">FailoverManager</a> will coordinate the different threads on failover to ensure they continue to use the same logical connection. </p>
</div>
</div>
<a class="anchor" id="ad5db4f3c25d41830ac1c3b28f771b5fe"></a><!-- doxytag: member="qpid::client::FailoverManager::getConnection" ref="ad5db4f3c25d41830ac1c3b28f771b5fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00058.html">Connection</a>& qpid::client::FailoverManager::getConnection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current connection whether open or not. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>qpid/client/<a class="el" href="a00465_source.html">FailoverManager.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>
|
