Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25761/src/java/net/sf/asterisk/manager
Modified Files:
ManagerConnection.java
Log Message:
fixed java doc
Index: ManagerConnection.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/ManagerConnection.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -p -r1.2 -r1.3
--- ManagerConnection.java 23 Feb 2005 22:50:57 -0000 1.2
+++ ManagerConnection.java 23 Feb 2005 23:00:50 -0000 1.3
@@ -22,8 +22,8 @@ import net.sf.asterisk.manager.action.Ma
import net.sf.asterisk.manager.response.ManagerResponse;
/**
- * The main interface to talk to an asterisk server via the manager api. A concrete implementation
- * of this interface is obtained from a ManagerConnectionFactory.
+ * The main interface to talk to an Asterisk server via the Asterisk Manager API. A concrete
+ * implementation of this interface can be obtained from a ManagerConnectionFactory.
*
* @see net.sf.asterisk.manager.ManagerConnectionFactory
*
@@ -36,7 +36,7 @@ public interface ManagerConnection
* Logs in to the asterisk server with the username and password specified when this connection
* was created.
*
- * @throws IOException
+ * @throws IOException if the network connection is disrupted.
* @throws AuthenticationFailedException if the username and/or password are incorrect or the
* ChallengeResponse could not be built.
* @throws TimeoutException if no response is received within the default timeout period. If the
@@ -51,7 +51,7 @@ public interface ManagerConnection
/**
* Sends a LogoffAction to the asterisk server and disconnects.
*
- * @throws IOException
+ * @throws IOException if the network connection is disrupted.
* @throws TimeoutException if no response to the logoff action is received within the default
* timeout period.
*
@@ -75,7 +75,7 @@ public interface ManagerConnection
*
* @return the corresponding response received from the asterisk server
*
- * @throws IOException
+ * @throws IOException if the network connection is disrupted.
* @throws TimeoutException if no reponse is received within the default timeout period.
*
* @see #sendAction(ManagerAction, long)
@@ -92,7 +92,7 @@ public interface ManagerConnection
*
* @return the corresponding response received from the asterisk server
*
- * @throws IOException
+ * @throws IOException if the network connection is disrupted.
* @throws TimeoutException if no reponse is received within the given timeout period.
*
* @see #sendAction(ManagerAction, ManagerResponseHandler)
@@ -106,7 +106,7 @@ public interface ManagerConnection
* @param action the action to send to the asterisk server
* @param callbackHandler the callback handler to call when the response is received
*
- * @throws IOException
+ * @throws IOException if the network connection is disrupted.
*/
void sendAction(ManagerAction action, ManagerResponseHandler callbackHandler) throws IOException;
@@ -131,9 +131,8 @@ public interface ManagerConnection
void removeEventHandler(ManagerEventHandler eventHandler);
/**
- * Return Asterisk server of connection
- *
+ * Returns the Asterisk server of this connection.
+ * @return the Asterisk server of this connection.
*/
-
AsteriskServer getAsteriskServer();
}
|
