[jboss-cvs] JBossRemoting/docs/guide/en ...

[Ron Sigal]

  User: rsigal  
  Date: 07/03/12 22:24:55

  Modified:    docs/guide/en  Tag: remoting_2_x chap8.xml
  Log:
  JBREM-657:  Reformated paragraphs so could compare with HEAD.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.4.2.2   +49 -48    JBossRemoting/docs/guide/en/chap8.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: chap8.xml
  ===================================================================
  RCS file: /cvsroot/jboss/JBossRemoting/docs/guide/en/chap8.xml,v
  retrieving revision 1.4.2.1
  retrieving revision 1.4.2.2
  diff -u -b -r1.4.2.1 -r1.4.2.2
  --- chap8.xml	13 Mar 2007 01:56:56 -0000	1.4.2.1
  +++ chap8.xml	13 Mar 2007 02:24:54 -0000	1.4.2.2
  @@ -30,28 +30,30 @@
   
     <bridgehead>Server side</bridgehead>
   
  -  <para>A remoting server also has the capability to detect when a client is
  -  no longer available. This is done by estabilishing a lease with the remoting
  +  <para>A remoting server also has the capability to detect when a client is no
  +  longer available. This is done by estabilishing a lease with the remoting
     clients that connect to a server.</para>
   
  -  <para>To turn on server side connection failure detection of remoting
  -  clients, will need to satisfy two criteria. The first is that the client
  -  lease period is set and is a value greater than 0. The value is represented
  -  in milliseconds. The client lease period can be set by either the
  -  'clientLeasePeriod' attribute within the Connector configuration or by
  -  calling the:<programlisting>public void setLeasePeriod(long leasePeriodValue)</programlisting>method
  -  within Connector. The second criterion is that an implementation of the
  +  <para>To turn on server side connection failure detection of remoting clients,
  +  will need to satisfy two criteria. The first is that the client lease period
  +  is set and is a value greater than 0. The value is represented in
  +  milliseconds. The client lease period can be set by either the
  +  'clientLeasePeriod' attribute within the Connector configuration or by calling
  +  the:<programlisting>public void setLeasePeriod(long
  +  leasePeriodValue)</programlisting>method within Connector. The second
  +  criterion is that an implementation of the
     <code>org.jboss.remoting.ConnectionListener</code> interface is added as a
  -  connection listener to the Connector, via the method:<programlisting>public void addConnectionListener(ConnectionListener listener)</programlisting>Note,
  -  there is no way to set the connection listener via xml based configuration
  -  for the Connector. Once both criteria are met, the remoting server will turn
  -  on client leasing.</para>
  +  connection listener to the Connector, via the method:<programlisting>public
  +  void addConnectionListener(ConnectionListener listener)</programlisting>Note,
  +  there is no way to set the connection listener via xml based configuration for
  +  the Connector. Once both criteria are met, the remoting server will turn on
  +  client leasing.</para>
   
     <para>The ConnectionListener will be notified of both client failures and
     client disconnects via the handleConnectionException() method. If the client
     failed, meaning its lease was not renewed within configured time period, the
  -  first parameter to the handleConnectionException() method will be null. If
  -  the client disconnected in a regular manner, the first parameter to the
  +  first parameter to the handleConnectionException() method will be null. If the
  +  client disconnected in a regular manner, the first parameter to the
     handleConnectionException() method will be of type
     ClientDisconnectedException (which indicates a normal termination). Note,
     the client's lease will be renewed on the server with any and every
  @@ -63,48 +65,47 @@
     lease window will always be set to lease period * 2 for any lease that does
     not have a lease update duration that is longer than 75% of the lease window
     (meaning if set lease period to 10 seconds and always update that lease in
  -  less then 7.5 seconds, the lease period will always remain 10 seconds). If
  -  the update duration is greater than 75% of the lease window, the lease
  -  window will be reset to the lease duration X 2 (meaning if set lease period
  -  to 10 seconds and update that lease in 8 seconds, the new lease window will
  -  be set to 16 seconds). Also, the lease will not immediately expire on the
  -  first lease timeout (meaning did not get an update within the lease window).
  -  It takes two consecutive timeouts before a lease will expire and a
  -  notification for client connection failure is fired. This essentially means
  -  that the time it will take before a connection listener is notified of a
  -  client connection failure will be at least 4 X lease period (no
  -  exceptions).</para>
  +  less then 7.5 seconds, the lease period will always remain 10 seconds). If the
  +  update duration is greater than 75% of the lease window, the lease window will
  +  be reset to the lease duration X 2 (meaning if set lease period to 10 seconds
  +  and update that lease in 8 seconds, the new lease window will be set to 16
  +  seconds). Also, the lease will not immediately expire on the first lease
  +  timeout (meaning did not get an update within the lease window). It takes two
  +  consecutive timeouts before a lease will expire and a notification for client
  +  connection failure is fired. This essentially means that the time it will take
  +  before a connection listener is notified of a client connection failure will
  +  be at least 4 X lease period (no exceptions).</para>
   
     <para>By default, the client is not configured to do client leasing. This
     means if want to allow client to do leasing, will need to either set invoker
  -  locator parameter of 'leasing' to true or include configuration entry with
  -  key of 'enableLease' and value of true to the map passed when creating a
  -  Client instance. This does not mean that client will lease for sure, but
  -  will indicate the client should call on the server to see if the server has
  -  activated leasing and get the leasing period desired by the server. If
  -  leasing turned on within the client can also override the lease period it
  +  locator parameter of 'leasing' to true or include configuration entry with key
  +  of 'enableLease' and value of true to the map passed when creating a Client
  +  instance. This does not mean that client will lease for sure, but will
  +  indicate the client should call on the server to see if the server has
  +  activated leasing and get the leasing period desired by the server. If leasing
  +  turned on within the client can also override the lease period it
     will use, ignoring the one sent by the server, by setting 'lease_period'
     parameter in the invoker locator parameters to millisecond value. Also worth
  -  noting is that if the client and server are local, meaning running within
  -  the jvm, leasing (and thus connection notification) will not be activated,
  -  even if is configured to do so.</para>
  +  noting is that if the client and server are local, meaning running within the
  +  jvm, leasing (and thus connection notification) will not be activated, even if
  +  is configured to do so.</para>
   
     <para>If leasing is turned on within the client side, there is no API or
  -  configuration changes needed, unless want to override as mentioned
  -  previously. When the client initially connects to the server, it will check
  -  to see if client leasing is turned on by the server. If it is, it will
  -  internally start pinging periodically to the server to maintain the lease.
  -  When the client disconnects, it will internally send message to the server
  -  to stop monitoring lease for this client. Therefore, it is <emphasis
  -  role="bold">IMPORTANT</emphasis> that disconnect is called on the client
  -  when done using it. Otherwise, the client will continue to make its ping
  -  call on the server to keep its lease current.</para>
  +  configuration changes needed, unless want to override as mentioned previously.
  +  When the client initially connects to the server, it will check to see if
  +  client leasing is turned on by the server. If it is, it will internally start
  +  pinging periodically to the server to maintain the lease. When the client
  +  disconnects, it will internally send message to the server to stop monitoring
  +  lease for this client. Therefore, it is <emphasis
  +  role="bold">IMPORTANT</emphasis> that disconnect is called on the client when
  +  done using it. Otherwise, the client will continue to make its ping call on
  +  the server to keep its lease current.</para>
   
     <para>The client can also provide extra metadata the will be communicated to
  -  the connection listener in case of failure by supplying a metadata Map to
  -  the Client constructor. This map will be included in the Client instance
  -  passed to the connection listener (via the handleConnectionException()
  -  method) via the Client's getConfiguration() method.</para>
  +  the connection listener in case of failure by supplying a metadata Map to the
  +  Client constructor. This map will be included in the Client instance passed to
  +  the connection listener (via the handleConnectionException() method) via the
  +  Client's getConfiguration() method.</para>
   
     <para>From the server side, there are two ways in which to disable leasing
     (i.e. turn leasing off). The first is to call:</para>