managerconnection.html

关于asterisk的java包

                throws java.io.IOException,
                       java.lang.IllegalArgumentException,
                       java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends a ManagerAction to the Asterisk server and registers a callback
 handler to be called when the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> is
 received. Be very careful that your callbackHandler terminates very
 quickly and does not do any fancy processing because it is called from
 the reader thread which is blocked for the time it takes to execute your
 callbackHandler.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action to send to the Asterisk server<DD><CODE>callback</CODE> - the callback handler to call when the response is
            received or <code>null</code> if you are not interested in
            the response
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to the Asterisk
             server.</DL>
</DD>
</DL>
<HR>

<A NAME="sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction)"><!-- --></A><H3>
sendEventGeneratingAction</H3>
<PRE>
<A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A> <B>sendEventGeneratingAction</B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action)
                                         throws java.io.IOException,
                                                <A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A>,
                                                java.lang.IllegalArgumentException,
                                                java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends an <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A> to the Asterisk server and waits
 for the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> and the
 <A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A>s
 <p>
 EventGeneratingActions are <A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action"><CODE>ManagerAction</CODE></A>s that don't return
 their response in the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> but send a
 series of events that contain the payload.
 <p>
 This method will block until the correpsonding action complete event has
 been received. The action complete event is determined by
 <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html#getActionCompleteEventClass()"><CODE>EventGeneratingAction.getActionCompleteEventClass()</CODE></A>.
 <p>
 Examples for EventGeneratingActions are
 <A HREF="../../../org/asteriskjava/manager/action/StatusAction.html" title="class in org.asteriskjava.manager.action"><CODE>StatusAction</CODE></A>,
 <CODE>org.asteriskjava.manager.action.QueueAction</CODE> or
 <A HREF="../../../org/asteriskjava/manager/action/AgentsAction.html" title="class in org.asteriskjava.manager.action"><CODE>AgentsAction</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action to send to the Asterisk server
<DT><B>Returns:</B><DD>a ResponseEvents that contains the corresponding response and
         response events received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A></CODE> - if no response or not all response events
             are received within the given timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>,
             the actionCompleteEventClass property of the action is
             <code>null</code> or if actionCompleteEventClass is not a
             ResponseEvent.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>Since:</B></DT>
  <DD>0.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, long)"><!-- --></A><H3>
sendEventGeneratingAction</H3>
<PRE>
<A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A> <B>sendEventGeneratingAction</B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action,
                                         long&nbsp;timeout)
                                         throws java.io.IOException,
                                                <A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A>,
                                                java.lang.IllegalArgumentException,
                                                java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends an <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A> to the Asterisk server and waits
 for the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> and the
 <A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A>s
 <p>
 EventGeneratingActions are <A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action"><CODE>ManagerAction</CODE></A>s that don't return
 their response in the corresponding <A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> but send a
 series of events that contain the payload.
 <p>
 This method will block until the correpsonding action complete event has
 been received but no longer that timeout seconds. The action complete
 event is determined by
 <A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html#getActionCompleteEventClass()"><CODE>EventGeneratingAction.getActionCompleteEventClass()</CODE></A>.
 <p>
 Examples for EventGeneratingActions are the
 <A HREF="../../../org/asteriskjava/manager/action/StatusAction.html" title="class in org.asteriskjava.manager.action"><CODE>StatusAction</CODE></A>, the
 <CODE>org.asteriskjava.manager.action.QueueAction</CODE> or the
 <A HREF="../../../org/asteriskjava/manager/action/AgentsAction.html" title="class in org.asteriskjava.manager.action"><CODE>AgentsAction</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action to send to the Asterisk server<DD><CODE>timeout</CODE> - milliseconds to wait for the response and the action
            complete event before throwing a TimeoutException
<DT><B>Returns:</B><DD>a ResponseEvents that contains the corresponding response and
         response events received from the Asterisk server
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager">EventTimeoutException</A></CODE> - if no response or not all response events
             are received within the given timeout period.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the action is <code>null</code>,
             the actionCompleteEventClass property of the action is
             <code>null</code> or if actionCompleteEventClass is not a
             ResponseEvent.
<DD><CODE>java.lang.IllegalStateException</CODE> - if you are not connected to an Asterisk
             server.<DT><B>Since:</B></DT>
  <DD>0.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action"><CODE>EventGeneratingAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/event/ResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ResponseEvent</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addEventListener(org.asteriskjava.manager.ManagerEventListener)"><!-- --></A><H3>
addEventListener</H3>
<PRE>
void <B>addEventListener</B>(<A HREF="../../../org/asteriskjava/manager/ManagerEventListener.html" title="interface in org.asteriskjava.manager">ManagerEventListener</A>&nbsp;eventListener)</PRE>
<DL>
<DD>Registers an event listener that is called whenever an
 <A HREF="../../../org/asteriskjava/manager/event/ManagerEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ManagerEvent</CODE></A> is receiced from the
 Asterisk server.
 <p>
 Event listeners are notified about new events in the same order as they
 were registered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>eventListener</CODE> - the listener to call whenever a manager event is
            received<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#removeEventListener(org.asteriskjava.manager.ManagerEventListener)"><CODE>removeEventListener(ManagerEventListener)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="removeEventListener(org.asteriskjava.manager.ManagerEventListener)"><!-- --></A><H3>
removeEventListener</H3>
<PRE>
void <B>removeEventListener</B>(<A HREF="../../../org/asteriskjava/manager/ManagerEventListener.html" title="interface in org.asteriskjava.manager">ManagerEventListener</A>&nbsp;eventListener)</PRE>
<DL>
<DD>Unregisters a previously registered event listener.
 <p>
 Does nothing if the given event listener hasn't be been regiered before.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>eventListener</CODE> - the listener to remove<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#addEventListener(org.asteriskjava.manager.ManagerEventListener)"><CODE>addEventListener(ManagerEventListener)</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ManagerConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Asterisk-Java</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/asteriskjava/manager/EventTimeoutException.html" title="class in org.asteriskjava.manager"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/asteriskjava/manager/ManagerConnectionFactory.html" title="class in org.asteriskjava.manager"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/asteriskjava/manager/ManagerConnection.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ManagerConnection.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 2004-2007 Stefan Reuter. All Rights Reserved.
</BODY>
</HTML>