[Ubermq-commits] jms/src/com/ubermq/jms/client/multicast LrmpClientSession.java,1.3,1.4 LrmpConnectionInfo.java,1.6,1.7 MulticastSequenceException.java,1.1,1.2 MulticastTopicConnection.java,1.3,1.4

[<ji...@us...>]

Update of /cvsroot/ubermq/jms/src/com/ubermq/jms/client/multicast
In directory usw-pr-cvs1:/tmp/cvs-serv18316/src/com/ubermq/jms/client/multicast

Modified Files:
	LrmpClientSession.java LrmpConnectionInfo.java 
	MulticastSequenceException.java MulticastTopicConnection.java 
Log Message:
client side documentation 


Index: LrmpClientSession.java
===================================================================
RCS file: /cvsroot/ubermq/jms/src/com/ubermq/jms/client/multicast/LrmpClientSession.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** LrmpClientSession.java	6 Sep 2002 15:55:57 -0000	1.3
--- LrmpClientSession.java	19 Sep 2002 17:30:31 -0000	1.4
***************
*** 1,33 ****
! package com.ubermq.jms.client.multicast;
! 
! import com.ubermq.kernel.*;
! import com.ubermq.jms.client.*;
! import com.ubermq.jms.client.impl.InternetConnectionDescriptor;
! 
! public class LrmpClientSession
! 	implements IClientSession
! {
! 	public static final int
! 		TTL_MACHINE = 0,
! 		TTL_SUBNET = 1,
! 		TTL_SITE = 15,
! 		TTL_REGION = 63,
! 		TTL_WORLDWIDE = 127;
! 	
! 	public LrmpClientSession()
! 	{
! 	}
! 	
! 	public void started(IConnectionInfo c)
! 	{
! 	}
! 	
! 	public IConnectionInfo connect(javax.jms.Connection cxn,
! 								   ConnectionDescriptor descriptor,
! 								   IMessageProcessor proc)
! 		throws java.io.IOException
! 	{
! 		InternetConnectionDescriptor d = (InternetConnectionDescriptor)descriptor;
! 		return new LrmpConnectionInfo(cxn, d.getHost(), d.getPort(), TTL_SUBNET, proc);
! 	}
! }
--- 1,38 ----
! package com.ubermq.jms.client.multicast;
! 
! import com.ubermq.kernel.*;
! import com.ubermq.jms.client.*;
! import com.ubermq.jms.client.impl.InternetConnectionDescriptor;
! 
! /**
!  * An LRMP client session, which creates an LRMP connection on behalf
!  * of a connection factory. Assumes TTL_SUBNET for all broadcasts. Someday
!  * this should be configurable on the connection factory level.
!  */
! public class LrmpClientSession
! 	implements IClientSession
! {
! 	public static final int
! 		TTL_MACHINE = 0,
! 		TTL_SUBNET = 1,
! 		TTL_SITE = 15,
! 		TTL_REGION = 63,
! 		TTL_WORLDWIDE = 127;
! 	
! 	public LrmpClientSession()
! 	{
! 	}
! 	
! 	public void started(IConnectionInfo c)
! 	{
! 	}
! 	
! 	public IConnectionInfo connect(javax.jms.Connection cxn,
! 								   ConnectionDescriptor descriptor,
! 								   IMessageProcessor proc)
! 		throws java.io.IOException
! 	{
! 		InternetConnectionDescriptor d = (InternetConnectionDescriptor)descriptor;
! 		return new LrmpConnectionInfo(cxn, d.getHost(), d.getPort(), TTL_SUBNET, proc);
! 	}
! }

Index: LrmpConnectionInfo.java
===================================================================
RCS file: /cvsroot/ubermq/jms/src/com/ubermq/jms/client/multicast/LrmpConnectionInfo.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** LrmpConnectionInfo.java	11 Sep 2002 18:35:10 -0000	1.6
--- LrmpConnectionInfo.java	19 Sep 2002 17:30:31 -0000	1.7
***************
*** 7,10 ****
--- 7,14 ----
  import java.nio.ByteBuffer;
  
+ /**
+  * Implements a connection processor using an LRMP reliable
+  * multicast transport layer.
+  */
  public class LrmpConnectionInfo
      extends AbstractConnectionInfo
***************
*** 17,20 ****
--- 21,34 ----
      private LrmpProfile profile;
  	
+ 	/**
+ 	 * Creates a connection with LRMP with some reasonable defaults. The
+ 	 * LRMP connection is set up to be lossless, with adaptive throughput
+ 	 * control, limited to 64 kb/s.
+ 	 * <P>
+ 	 * @param cxn the JMS connection object.
+ 	 * @param group the multicast group (a class D address)
+ 	 * @param port the port
+ 	 * @param ttl the time-to-live, one of the LrmpClientSession.TTL_xxx values
+ 	 */
      public LrmpConnectionInfo(javax.jms.Connection cxn,
  							  String group,

Index: MulticastSequenceException.java
===================================================================
RCS file: /cvsroot/ubermq/jms/src/com/ubermq/jms/client/multicast/MulticastSequenceException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** MulticastSequenceException.java	9 Aug 2002 15:17:54 -0000	1.1
--- MulticastSequenceException.java	19 Sep 2002 17:30:31 -0000	1.2
***************
*** 1,4 ****
--- 1,8 ----
  package com.ubermq.jms.client.multicast;
  
+ /**
+  * Thrown when an unrecoverable multicast sequence error
+  * is indicated by the LRMP reliable multicast transport layer.
+  */
  public class MulticastSequenceException
  	extends javax.jms.JMSException

Index: MulticastTopicConnection.java
===================================================================
RCS file: /cvsroot/ubermq/jms/src/com/ubermq/jms/client/multicast/MulticastTopicConnection.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** MulticastTopicConnection.java	11 Sep 2002 18:35:10 -0000	1.3
--- MulticastTopicConnection.java	19 Sep 2002 17:30:31 -0000	1.4
***************
*** 8,11 ****
--- 8,15 ----
  import java.io.IOException;
  
+ /**
+  * A topic connection that uses LRMP multicast to send and receive messages
+  * from a set of nodes.
+  */
  public class MulticastTopicConnection
      extends TopicConnection
***************
*** 13,16 ****
--- 17,25 ----
      private static IClientSession theSession = new LrmpClientSession();
      
+ 	/**
+ 	 * Creates a multicast topic connection on the given class D address and port.
+ 	 * @param host a multicast address
+ 	 * @param port the port to use
+ 	 */
      public MulticastTopicConnection(String host, int port)
          throws IOException