[Beepcore-java-commits] CVS: beepcore-java/src/org/beepcore/beep/transport/tcp TCPSession.java,1.14,1.15 TCPSessionCreator.java,1.4,1.5

[Huston F. <hu...@us...>]

Update of /cvsroot/beepcore-java/beepcore-java/src/org/beepcore/beep/transport/tcp
In directory usw-pr-cvs1:/tmp/cvs-serv8121/org/beepcore/beep/transport/tcp

Modified Files:
	TCPSession.java TCPSessionCreator.java 
Log Message:
Updated javadoc

Index: TCPSession.java
===================================================================
RCS file: /cvsroot/beepcore-java/beepcore-java/src/org/beepcore/beep/transport/tcp/TCPSession.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -r1.14 -r1.15
*** TCPSession.java	2001/11/08 03:59:37	1.14
--- TCPSession.java	2001/11/08 05:26:29	1.15
***************
*** 3,11 ****
   *
   * Copyright (c) 2001 Invisible Worlds, Inc.  All rights reserved.
   *
   * The contents of this file are subject to the Blocks Public License (the
   * "License"); You may not use this file except in compliance with the License.
   *
!  * You may obtain a copy of the License at http://www.invisible.net/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
--- 3,12 ----
   *
   * Copyright (c) 2001 Invisible Worlds, Inc.  All rights reserved.
+  * Copyright (c) 2001 Huston Franklin.  All rights reserved.
   *
   * The contents of this file are subject to the Blocks Public License (the
   * "License"); You may not use this file except in compliance with the License.
   *
!  * You may obtain a copy of the License at http://www.beepcore.org/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
***************
*** 42,50 ****
  
  /**
!  * This class encapsulates the notion of a BEEP Session ( a relationship
!  * between BEEP peers) that exists over a TCP (socket-based) connection.
!  * Notice that I've set up properties for both the TCPSession class (statics)
!  * and the instance itself.  This may change, but for now it provides us
!  * a general management facility with various degrees of granularity.
   *
   * @author Eric Dixon
--- 43,47 ----
  
  /**
!  * Provides the TCP transport mapping for BEEP according to RFC 3081.
   *
   * @author Eric Dixon
***************
*** 138,142 ****
  
      /**
!      * Method initiate
       *
       *
--- 135,140 ----
  
      /**
!      * Creates a TCPSession for a Socket that was created by
!      * initiating a connection.
       *
       *
***************
*** 156,160 ****
  
      /**
!      * Method listen
       *
       *
--- 154,159 ----
  
      /**
!      * Creates a TCPSession for a Socket that was created by
!      * listening and accepting a connection.
       *
       *
***************
*** 245,251 ****
  
      /**
!      * Socket-level call to send a frame along a socket.  Generates
!      * a header, then writes the header, payload, and trailer to
!      * the wire.
       *
       * @param f the Frame to send.
--- 244,249 ----
  
      /**
!      * Generates a header, then writes the header, payload, and
!      * trailer to the wire.
       *
       * @param f the Frame to send.
***************
*** 328,349 ****
  
      /**
!      * This method is designed to allow for flow control across the multiplexed
!      * connection we have.  The only subclass at present - TCPSession -
!      * implements
!      * a real version of it.  The idea is to throttle data being sent over this
!      * session to be manageable per Channel, so that a given Channel doesn't
!      * take
!      * up all the bandwidth.  The Java implementation is constrained a bit by a
!      * dependency on the Socket's get/setReceiveBufferSize calls.  Because of
!      * how we've designed the library, it's impossible for us to actually have
!      * a socket during the greeting period, therefore, we use a default minimal
!      * buffer size of 4k bytes in the initial SEQ frame.  Once the constructor
!      * for TCPSession has completed (the greeting has been sent) and we have
!      * a real socket, then we attempt to set the buffer size based on the
!      * definitions in <code>Constants</code>, and allow things to go.
!      *
!      * This method restricts the bufferSize, per the beep spec, to be at most
!      * two-thirds of the socket's receiveBufferSize.  If a size is requested
!      * beyond that, an exception is thrown.
       *
       *
--- 326,331 ----
  
      /**
!      * Update the channel window size with the remote peer by sending
!      * SEQ frames as per RFC 3081.
       *
       *

Index: TCPSessionCreator.java
===================================================================
RCS file: /cvsroot/beepcore-java/beepcore-java/src/org/beepcore/beep/transport/tcp/TCPSessionCreator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** TCPSessionCreator.java	2001/11/08 03:59:37	1.4
--- TCPSessionCreator.java	2001/11/08 05:26:29	1.5
***************
*** 3,11 ****
   *
   * Copyright (c) 2001 Invisible Worlds, Inc.  All rights reserved.
   *
   * The contents of this file are subject to the Blocks Public License (the
   * "License"); You may not use this file except in compliance with the License.
   *
!  * You may obtain a copy of the License at http://www.invisible.net/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
--- 3,12 ----
   *
   * Copyright (c) 2001 Invisible Worlds, Inc.  All rights reserved.
+  * Copyright (c) 2001 Huston Franklin.  All rights reserved.
   *
   * The contents of this file are subject to the Blocks Public License (the
   * "License"); You may not use this file except in compliance with the License.
   *
!  * You may obtain a copy of the License at http://www.beepcore.org/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
***************
*** 36,49 ****
   * This class provides a means for applications or other libraries to create
   * a TCP-based BEEP Session with another BEEP peer.
-  *
-  * The Socket-based initiate and listen calls are in the
-  * <code>AutomatedTCPSessionFactory</code>.
-  *
-  * Opportunities for polymorphic factory methods are rampant here, depending
-  * upon how one wants to represent hosts, and whether helper objects
-  * (such as the dreaded profile manager concept) might be used as parameters
-  * in classes that extend this one.
-  * It is assumed that the callpath started here in Session Factory handles the
-  * Greeting exchange and so on, done either here or in the constructors.
   *
   * @author Eric Dixon
--- 37,40 ----