managerconnection.html

关于asterisk的java包

<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#login(java.lang.String)">login</A></B>(java.lang.String&nbsp;events)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs in to the Asterisk server with the username and password specified
 when this connection was created and a given event mask.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#logoff()">logoff</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a LogoffAction to the Asterisk server and disconnects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#registerUserEventClass(java.lang.Class)">registerUserEventClass</A></B>(java.lang.Class&nbsp;userEventClass)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers a new user event type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#removeEventListener(org.asteriskjava.manager.ManagerEventListener)">removeEventListener</A></B>(<A HREF="../../../org/asteriskjava/manager/ManagerEventListener.html" title="interface in org.asteriskjava.manager">ManagerEventListener</A>&nbsp;eventListener)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unregisters a previously registered event listener.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction)">sendAction</A></B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a ManagerAction to the Asterisk server and waits for the
 corresponding ManagerResponse.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response">ManagerResponse</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, long)">sendAction</A></B>(<A HREF="../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A>&nbsp;action,
           long&nbsp;timeout)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendAction(org.asteriskjava.manager.action.ManagerAction, org.asteriskjava.manager.SendActionCallback)">sendAction</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction)">sendEventGeneratingAction</A></B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../org/asteriskjava/manager/ResponseEvents.html" title="interface in org.asteriskjava.manager">ResponseEvents</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#sendEventGeneratingAction(org.asteriskjava.manager.action.EventGeneratingAction, long)">sendEventGeneratingAction</A></B>(<A HREF="../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>&nbsp;action,
                          long&nbsp;timeout)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketReadTimeout(int)">setSocketReadTimeout</A></B>(int&nbsp;socketReadTimeout)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connection is dropped (and restarted) if it stales on read longer than
 the timeout.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/asteriskjava/manager/ManagerConnection.html#setSocketTimeout(int)">setSocketTimeout</A></B>(int&nbsp;socketTimeout)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The timeout to use when connecting the the Asterisk server.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getHostname()"><!-- --></A><H3>
getHostname</H3>
<PRE>
java.lang.String <B>getHostname</B>()</PRE>
<DL>
<DD>Returns the hostname of the connected Asterisk server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the hostname of the connected Asterisk server.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPort()"><!-- --></A><H3>
getPort</H3>
<PRE>
int <B>getPort</B>()</PRE>
<DL>
<DD>Returns the Manager API port of the connected Asterisk server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the Manager API port of the connected Asterisk server.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getUsername()"><!-- --></A><H3>
getUsername</H3>
<PRE>
java.lang.String <B>getUsername</B>()</PRE>
<DL>
<DD>Returns the username to use to connect to the Asterisk server. This is
 the username specified in Asterisk's <code>manager.conf</code> file.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the username to use for login<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPassword()"><!-- --></A><H3>
getPassword</H3>
<PRE>
java.lang.String <B>getPassword</B>()</PRE>
<DL>
<DD>Returns the password to use to connect to the Asterisk server. This is
 the username specified in Asterisk's <code>manager.conf</code> file.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the password to use for login<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isSsl()"><!-- --></A><H3>
isSsl</H3>
<PRE>
boolean <B>isSsl</B>()</PRE>
<DL>
<DD>Returns whether to use SSL.
 <p>
 Default is false.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if SSL is used for the connection,
         <code>false</code> for a plain text connection.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="registerUserEventClass(java.lang.Class)"><!-- --></A><H3>
registerUserEventClass</H3>
<PRE>
void <B>registerUserEventClass</B>(java.lang.Class&nbsp;userEventClass)</PRE>
<DL>
<DD>Registers a new user event type.
 <p>
 Asterisk allows you to send custom events via the UserEvent application.
 If you choose to send such events you can extend the abstract class
 UserEvent provide a name for your new event and optionally add your own
 attributes. After registering a user event type Asterisk-Java will handle
 such events the same way it handles the internal events and inform your
 registered event handlers.
 <p>
 Note: If you write your own Asterisk applications that use Asterisk's
 <code>manager_event()</code> function directly and don't use the
 channel and uniqueid attributes provided by UserEvent you can also
 register events that directly subclass <A HREF="../../../org/asteriskjava/manager/event/ManagerEvent.html" title="class in org.asteriskjava.manager.event"><CODE>ManagerEvent</CODE></A>.
 <p>
 The event class must be a concrete class with a default constructor (one
 that takes no arguments).