managerconnection.html

关于asterisk的java包

<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>userEventClass</CODE> - the class representing the user event to register.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if userEventClass is not a valid event
             class.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/event/UserEvent.html" title="class in org.asteriskjava.manager.event"><CODE>UserEvent</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/event/ManagerEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ManagerEvent</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setSocketTimeout(int)"><!-- --></A><H3>
setSocketTimeout</H3>
<PRE>
void <B>setSocketTimeout</B>(int&nbsp;socketTimeout)</PRE>
<DL>
<DD>The timeout to use when connecting the the Asterisk server.
 <p>
 Default is 0, that is using Java's built-in default.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>socketTimeout</CODE> - the timeout value to be used in milliseconds.<DT><B>Since:</B></DT>
  <DD>0.2</DD>
<DT><B>See Also:</B><DD><CODE>Socket.connect(java.net.SocketAddress, int)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setSocketReadTimeout(int)"><!-- --></A><H3>
setSocketReadTimeout</H3>
<PRE>
void <B>setSocketReadTimeout</B>(int&nbsp;socketReadTimeout)</PRE>
<DL>
<DD>Connection is dropped (and restarted) if it stales on read longer than
 the timeout.
 <p>
 If you set this property to a non zero value be sure to also use a
 <A HREF="../../../org/asteriskjava/manager/PingThread.html" title="class in org.asteriskjava.manager"><CODE>PingThread</CODE></A> or somthing similar to make sure there is some network
 traffic, otherwise you will encounter lots of unexpected reconnects. The
 read timeout should be at least twice the interval set for the
 PingThread.
 <p>
 Default is 0, that is no read timeout.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>socketReadTimeout</CODE> - the read timeout value to be used in
            milliseconds.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
<DT><B>See Also:</B><DD><CODE>Socket.setSoTimeout(int)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="login()"><!-- --></A><H3>
login</H3>
<PRE>
void <B>login</B>()
           throws java.lang.IllegalStateException,
                  java.io.IOException,
                  <A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A>,
                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></PRE>
<DL>
<DD>Logs in to the Asterisk server with the username and password specified
 when this connection was created.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if connection is not in state INITIAL or
             DISCONNECTED.
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A></CODE> - if the username and/or password are
             incorrect or the ChallengeResponse could not be built.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if a timeout occurs while waiting for the
             protocol identifier. The connection is closed in this case.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/LoginAction.html" title="class in org.asteriskjava.manager.action"><CODE>LoginAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/action/ChallengeAction.html" title="class in org.asteriskjava.manager.action"><CODE>ChallengeAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="login(java.lang.String)"><!-- --></A><H3>
login</H3>
<PRE>
void <B>login</B>(java.lang.String&nbsp;events)
           throws java.lang.IllegalStateException,
                  java.io.IOException,
                  <A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A>,
                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></PRE>
<DL>
<DD>Logs in to the Asterisk server with the username and password specified
 when this connection was created and a given event mask.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>events</CODE> - the event mask. Set to "on" if all events should be send,
            "off" if not events should be sent or a combination of
            "system", "call" and "log" (separated by ',') to specify what
            kind of events should be sent.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if connection is not in state INITIAL or
             DISCONNECTED.
<DD><CODE>java.io.IOException</CODE> - if the network connection is disrupted.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/AuthenticationFailedException.html" title="class in org.asteriskjava.manager">AuthenticationFailedException</A></CODE> - if the username and/or password are
             incorrect or the ChallengeResponse could not be built.
<DD><CODE><A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if a timeout occurs while waiting for the
             protocol identifier. The connection is closed in this case.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/LoginAction.html" title="class in org.asteriskjava.manager.action"><CODE>LoginAction</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/action/ChallengeAction.html" title="class in org.asteriskjava.manager.action"><CODE>ChallengeAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="logoff()"><!-- --></A><H3>
logoff</H3>
<PRE>
void <B>logoff</B>()
            throws java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends a LogoffAction to the Asterisk server and disconnects.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if not in state CONNECTED or RECONNECTING.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/LogoffAction.html" title="class in org.asteriskjava.manager.action"><CODE>LogoffAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getProtocolIdentifier()"><!-- --></A><H3>
getProtocolIdentifier</H3>
<PRE>
java.lang.String <B>getProtocolIdentifier</B>()</PRE>
<DL>
<DD>Returns the protocol identifier, that is a string like "Asterisk Call
 Manager/1.0".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the protocol identifier of the Asterisk Manager Interface in use
         if it has already been received; <code>null</code> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
<A HREF="../../../org/asteriskjava/manager/ManagerConnectionState.html" title="enum in org.asteriskjava.manager">ManagerConnectionState</A> <B>getState</B>()</PRE>
<DL>
<DD>Returns the lifecycle status of this connection.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the lifecycle status of this connection.</DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction)"><!-- --></A><H3>
sendAction</H3>
<PRE>
<A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A> <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action)
                           throws java.io.IOException,
                                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A>,
                                  java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends a ManagerAction to the Asterisk server and waits for the
 corresponding ManagerResponse.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action to send to the Asterisk server
<DT><B>Returns:</B><DD>the corresponding response 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/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if no response is received within the default
             timeout period.
<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 an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, long)"><CODE>sendAction(ManagerAction, long)</CODE></A>, 
<A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><CODE>sendAction(ManagerAction, SendActionCallback)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction, long)"><!-- --></A><H3>
sendAction</H3>
<PRE>
<A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A> <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action,
                           long&nbsp;timeout)
                           throws java.io.IOException,
                                  <A HREF="../../../org/asteriskjava/manager/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A>,
                                  java.lang.IllegalArgumentException,
                                  java.lang.IllegalStateException</PRE>
<DL>
<DD>Sends a ManagerAction 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>.
<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 before throwing a
            TimeoutException
<DT><B>Returns:</B><DD>the corresponding response 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/TimeoutException.html" title="class in org.asteriskjava.manager">TimeoutException</A></CODE> - if no response is received within the given
             timeout period.
<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 an Asterisk
             server.<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><CODE>sendAction(ManagerAction, SendActionCallback)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)"><!-- --></A><H3>
sendAction</H3>
<PRE>
void <B>sendAction</B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action,
                <A HREF="../../../org/asteriskjava/manager/SendActionCallback.html" title="interface in org.asteriskjava.manager">SendActionCallback</A>&nbsp;callback)