source: branches/objectmq-1.0/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/impl/ChannelManager.html

Last change on this file was 33, checked in by amoreno, 11 years ago

new release version
File size: 15.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_18) on Tue Dec 11 11:47:10 GMT 2012 -->
6<TITLE>
7ChannelManager
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="ChannelManager";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/AMQImpl.Tx.SelectOk.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../../index.html?com/rabbitmq/client/impl/ChannelManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="ChannelManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client.impl</FONT>
91<BR>
92Class ChannelManager</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.impl.ChannelManager</B>
96</PRE>
97<HR>
98<DL>
99<DT><PRE>public final class <B>ChannelManager</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103Manages a set of channels, indexed by channel number (<code><b>1.._channelMax</b></code>).
104<P>
105
106<P>
107<HR>
108
109<P>
110
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112
113<A NAME="constructor_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Constructor Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#ChannelManager(com.rabbitmq.client.impl.ConsumerWorkService, int)">ChannelManager</A></B>(com.rabbitmq.client.impl.ConsumerWorkService&nbsp;workService,
121               int&nbsp;channelMax)</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ========== METHOD SUMMARY =========== -->
129
130<A NAME="method_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
134<B>Method Summary</B></FONT></TH>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A></CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#createChannel(com.rabbitmq.client.impl.AMQConnection)">createChannel</A></B>(<A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A>&nbsp;connection)</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A></CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#createChannel(com.rabbitmq.client.impl.AMQConnection, int)">createChannel</A></B>(<A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A>&nbsp;connection,
148              int&nbsp;channelNumber)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A></CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#getChannel(int)">getChannel</A></B>(int&nbsp;channelNumber)</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Looks up a channel on this connection.</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;int</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#getChannelMax()">getChannelMax</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#handleSignal(com.rabbitmq.client.ShutdownSignalException)">handleSignal</A></B>(<A HREF="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A>&nbsp;signal)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handle shutdown.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;void</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/ChannelManager.html#releaseChannelNumber(com.rabbitmq.client.impl.ChannelN)">releaseChannelNumber</A></B>(<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A>&nbsp;channel)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the channel from the channel map and free the number for re-use.</TD>
184</TR>
185</TABLE>
186&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193</TR>
194</TABLE>
195&nbsp;
196<P>
197
198<!-- ========= CONSTRUCTOR DETAIL ======== -->
199
200<A NAME="constructor_detail"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
204<B>Constructor Detail</B></FONT></TH>
205</TR>
206</TABLE>
207
208<A NAME="ChannelManager(com.rabbitmq.client.impl.ConsumerWorkService, int)"><!-- --></A><H3>
209ChannelManager</H3>
210<PRE>
211public <B>ChannelManager</B>(com.rabbitmq.client.impl.ConsumerWorkService&nbsp;workService,
212                      int&nbsp;channelMax)</PRE>
213<DL>
214</DL>
215
216<!-- ============ METHOD DETAIL ========== -->
217
218<A NAME="method_detail"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
222<B>Method Detail</B></FONT></TH>
223</TR>
224</TABLE>
225
226<A NAME="getChannelMax()"><!-- --></A><H3>
227getChannelMax</H3>
228<PRE>
229public int <B>getChannelMax</B>()</PRE>
230<DL>
231<DD><DL>
232</DL>
233</DD>
234</DL>
235<HR>
236
237<A NAME="getChannel(int)"><!-- --></A><H3>
238getChannel</H3>
239<PRE>
240public <A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A> <B>getChannel</B>(int&nbsp;channelNumber)</PRE>
241<DL>
242<DD>Looks up a channel on this connection.
243<P>
244<DD><DL>
245<DT><B>Parameters:</B><DD><CODE>channelNumber</CODE> - the number of the required channel
246<DT><B>Returns:</B><DD>the channel on this connection with number <code><b>channelNumber</b></code>
247<DT><B>Throws:</B>
248<DD><CODE>UnknownChannelException</CODE> - if there is no channel with number <code><b>channelNumber</b></code> on this connection</DL>
249</DD>
250</DL>
251<HR>
252
253<A NAME="handleSignal(com.rabbitmq.client.ShutdownSignalException)"><!-- --></A><H3>
254handleSignal</H3>
255<PRE>
256public void <B>handleSignal</B>(<A HREF="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A>&nbsp;signal)</PRE>
257<DL>
258<DD>Handle shutdown. All the managed <A HREF="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client"><CODE>Channel</CODE></A>s are shutdown.
259<P>
260<DD><DL>
261<DT><B>Parameters:</B><DD><CODE>signal</CODE> - reason for shutdown</DL>
262</DD>
263</DL>
264<HR>
265
266<A NAME="createChannel(com.rabbitmq.client.impl.AMQConnection)"><!-- --></A><H3>
267createChannel</H3>
268<PRE>
269public <A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A> <B>createChannel</B>(<A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A>&nbsp;connection)
270                       throws java.io.IOException</PRE>
271<DL>
272<DD><DL>
273
274<DT><B>Throws:</B>
275<DD><CODE>java.io.IOException</CODE></DL>
276</DD>
277</DL>
278<HR>
279
280<A NAME="createChannel(com.rabbitmq.client.impl.AMQConnection, int)"><!-- --></A><H3>
281createChannel</H3>
282<PRE>
283public <A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A> <B>createChannel</B>(<A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A>&nbsp;connection,
284                              int&nbsp;channelNumber)
285                       throws java.io.IOException</PRE>
286<DL>
287<DD><DL>
288
289<DT><B>Throws:</B>
290<DD><CODE>java.io.IOException</CODE></DL>
291</DD>
292</DL>
293<HR>
294
295<A NAME="releaseChannelNumber(com.rabbitmq.client.impl.ChannelN)"><!-- --></A><H3>
296releaseChannelNumber</H3>
297<PRE>
298public void <B>releaseChannelNumber</B>(<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A>&nbsp;channel)</PRE>
299<DL>
300<DD>Remove the channel from the channel map and free the number for re-use.
301 This method must be safe to call multiple times on the same channel. If
302 it is not then things go badly wrong.
303<P>
304<DD><DL>
305</DL>
306</DD>
307</DL>
308<!-- ========= END OF CLASS DATA ========= -->
309<HR>
310
311
312<!-- ======= START OF BOTTOM NAVBAR ====== -->
313<A NAME="navbar_bottom"><!-- --></A>
314<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
315<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
316<TR>
317<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
318<A NAME="navbar_bottom_firstrow"><!-- --></A>
319<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
320  <TR ALIGN="center" VALIGN="top">
321  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
322  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
323  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
324  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
325  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
326  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
327  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
328  </TR>
329</TABLE>
330</TD>
331<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
332</EM>
333</TD>
334</TR>
335
336<TR>
337<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
338&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/AMQImpl.Tx.SelectOk.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
339&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD>
340<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
341  <A HREF="../../../../index.html?com/rabbitmq/client/impl/ChannelManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
342&nbsp;<A HREF="ChannelManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
343&nbsp;<SCRIPT type="text/javascript">
344  <!--
345  if(window==top) {
346    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
347  }
348  //-->
349</SCRIPT>
350<NOSCRIPT>
351  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
352</NOSCRIPT>
353
354
355</FONT></TD>
356</TR>
357<TR>
358<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
359  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
360<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
361DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
362</TR>
363</TABLE>
364<A NAME="skip-navbar_bottom"></A>
365<!-- ======== END OF BOTTOM NAVBAR ======= -->
366
367<HR>
368
369</BODY>
370</HTML>
Note: See TracBrowser for help on using the repository browser.