[jboss-cvs] JBossRemoting/src/main/org/jboss/remoting/transport/socket ...

[Tom Elrod]

  User: telrod  
  Date: 06/07/19 12:39:17

  Modified:    src/main/org/jboss/remoting/transport/socket  
                        MicroSocketClientInvoker.java
                        SocketServerInvoker.java
  Log:
  JBREM-507 - updating/adding javadoc for configuration properties.
  
  Revision  Changes    Path
  1.11      +23 -1     JBossRemoting/src/main/org/jboss/remoting/transport/socket/MicroSocketClientInvoker.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: MicroSocketClientInvoker.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossRemoting/src/main/org/jboss/remoting/transport/socket/MicroSocketClientInvoker.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -b -r1.10 -r1.11
  --- MicroSocketClientInvoker.java	5 Jul 2006 16:51:54 -0000	1.10
  +++ MicroSocketClientInvoker.java	19 Jul 2006 16:39:17 -0000	1.11
  @@ -30,17 +30,38 @@
    *
    * @author <a href="mailto:jhaynie at vocalocity.net">Jeff Haynie</a>
    * @author <a href="mailto:telrod at e2technologies.net">Tom Elrod</a>
  - * @version $Revision: 1.10 $
  + * @version $Revision: 1.11 $
    */
   public class MicroSocketClientInvoker extends RemoteClientInvoker
   {
      protected InetAddress addr;
      protected int port;
   
  +   /**
  +    * can be either true or false and will indicate if client socket should have TCP_NODELAY turned on or off.
  +    * TCP_NODELAY is for a specific purpose; to disable the Nagle buffering algorithm.
  +    * It should only be set for applications that send frequent small bursts of information without
  +    * getting an immediate response; where timely delivery of data is required
  +    * (the canonical example is mouse movements). The default is false.
  +    */
      public static final String TCP_NODELAY_FLAG = "enableTcpNoDelay";
  +
  +   /**
  +    * the client side maximum number of threads. The default is MAX_POOL_SIZE.
  +    */
      public static final String MAX_POOL_SIZE_FLAG = "clientMaxPoolSize";
  +
  +   /**
  +    * Specifies the fully qualified class name for the custom SocketWrapper implementation
  +    * to use on the client. Note, will need to make sure this is marked as a client
  +    * parameter (using the 'isParam' attribute). Making this change will not
  +    * affect the marshaller/unmarshaller that is used, which may also be a requirement.
  +    */
      public static final String CLIENT_SOCKET_CLASS_FLAG = "clientSocketClass";
   
  +   /**
  +    * Default value for enable TCP nodelay.  Value is false.
  +    */
      public static final boolean TCP_NODELAY_DEFAULT = false;
   
      /**
  @@ -102,6 +123,7 @@
       * point in time.  Default is 50.
       */
      public static final int MAX_POOL_SIZE = 50;
  +
      protected int maxPoolSize = MAX_POOL_SIZE;
   
      private boolean reuseAddress = true;
  
  
  
  1.29      +7 -2      JBossRemoting/src/main/org/jboss/remoting/transport/socket/SocketServerInvoker.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: SocketServerInvoker.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossRemoting/src/main/org/jboss/remoting/transport/socket/SocketServerInvoker.java,v
  retrieving revision 1.28
  retrieving revision 1.29
  diff -u -b -r1.28 -r1.29
  --- SocketServerInvoker.java	29 Jun 2006 17:25:00 -0000	1.28
  +++ SocketServerInvoker.java	19 Jul 2006 16:39:17 -0000	1.29
  @@ -43,7 +43,7 @@
    *
    * @author <a href="mailto:jhaynie at vocalocity.net">Jeff Haynie</a>
    * @author <a href="mailto:tom.elrod at jboss.com">Tom Elrod</a>
  - * @version $Revision: 1.28 $
  + * @version $Revision: 1.29 $
    * @jmx:mbean
    */
   public class SocketServerInvoker extends ServerInvoker implements Runnable, SocketServerInvokerMBean
  @@ -57,10 +57,15 @@
      private static int BACKLOG_DEFAULT = 200;
      private static int MAX_POOL_SIZE_DEFAULT = 300;
   
  +   /**
  +    * Key for indicating if socket invoker should continue to keep socket connection between
  +    * client and server open after invocations by sending a ping on the connection
  +    * before being re-used.  The default for this is false.
  +    */
      public static final String CHECK_CONNECTION_KEY = "socket.check_connection";
   
      /**
  -    * Property value to set if want a custom socket wrapper for providing custom streams.
  +    * Specifies the fully qualified class name for the custom SocketWrapper implementation to use on the server.
       */
      public static final String SERVER_SOCKET_CLASS_FLAG = "serverSocketClass";
      private String serverSocketClass = ServerSocketWrapper.class.getName();