Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23830/src/java/net/sf/asterisk/manager
Modified Files:
DefaultAsteriskManager.java DefaultManagerConnection.java
AsteriskManager.java
Log Message:
Added javadocs
Index: DefaultAsteriskManager.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/DefaultAsteriskManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -p -r1.5 -r1.6
--- DefaultAsteriskManager.java 22 Jun 2005 18:27:12 -0000 1.5
+++ DefaultAsteriskManager.java 7 Jul 2005 00:27:29 -0000 1.6
@@ -51,6 +51,9 @@ import net.sf.asterisk.util.Log;
import net.sf.asterisk.util.LogFactory;
/**
+ * Default implementation of the AsteriskManager interface.
+ *
+ * @see net.sf.asterisk.manager.AsteriskManager
* @author srt
* @version $Id$
*/
@@ -113,6 +116,8 @@ public class DefaultAsteriskManager
connection.sendAction(new QueueStatusAction());
}
+ /* Implementation of the AsteriskManager interface */
+
public Call originateCall(Originate originate) throws TimeoutException,
IOException, Exception
{
@@ -176,6 +181,8 @@ public class DefaultAsteriskManager
return queues;
}
+ /* Implementation of the ManagerEventHandler interface */
+
/**
* Handles all events received from the asterisk server.<br>
* Events are queued until channels and queues are initialized and then
Index: DefaultManagerConnection.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/DefaultManagerConnection.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -p -r1.18 -r1.19
--- DefaultManagerConnection.java 7 Jul 2005 00:09:26 -0000 1.18
+++ DefaultManagerConnection.java 7 Jul 2005 00:27:35 -0000 1.19
@@ -46,9 +46,9 @@ import net.sf.asterisk.util.LogFactory;
/**
* Default implemention of the ManagerConnection interface.
*
+ * @see net.sf.asterisk.manager.ManagerConnection
* @author srt
- * @version $Id: DefaultManagerConnection.java,v 1.15 2005/04/23 22:56:38 srt
- * Exp $
+ * @version $Id$
*/
public class DefaultManagerConnection implements ManagerConnection, Dispatcher
{
Index: AsteriskManager.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/AsteriskManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -p -r1.5 -r1.6
--- AsteriskManager.java 22 Jun 2005 18:27:12 -0000 1.5
+++ AsteriskManager.java 7 Jul 2005 00:27:35 -0000 1.6
@@ -20,6 +20,14 @@ import java.io.IOException;
import java.util.Map;
/**
+ * The AsteriskManager is built on top of the ManagerConnection and is an
+ * attempt to simplify interaction with Asterisk by abstracting the interface.<br>
+ * You will certainly have less freedom using AsteriskManager but it will make
+ * life easier for easy things (like originating a call or getting a list of
+ * open channels).<br>
+ * AsteriskManager is still in an early state of development. So, when using
+ * AsteriskManager be aware that it might change in the future.
+ *
* @author srt
* @version $Id$
*/
@@ -30,11 +38,11 @@ public interface AsteriskManager
*
* @param originate conatins the details of the call to originate
* @return a Call object representing the originated call
- *
* @throws TimeoutException if the originated call is not answered in time
* @throws IOException if the action cannot be sent to the asterisk server
*/
- public Call originateCall(Originate originate) throws TimeoutException, IOException, Exception;
+ public Call originateCall(Originate originate) throws TimeoutException,
+ IOException, Exception;
/**
* Returns a Map of active channels.<br>
@@ -47,7 +55,8 @@ public interface AsteriskManager
/**
* Returns a Map of all queues.<br>
- * The map contains the queue names as keys and objects of type {@link Queue} as values.
+ * The map contains the queue names as keys and objects of type
+ * {@link Queue} as values.
*
* @return a Map of queues.
*/
|
