Author: mahadev Date: Thu Jan 8 13:40:55 2009 New Revision: 732831 URL: http://svn.apache.org/viewvc?rev=732831&view=rev Log: ZOOKEEPER-258. docs incorrectly state max client timeout as 60 seconds (it's based on server ticktime). (phunt via mahadev)
Modified: hadoop/zookeeper/trunk/CHANGES.txt hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Modified: hadoop/zookeeper/trunk/CHANGES.txt URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/CHANGES.txt?rev=732831&r1=732830&r2=732831&view=diff ============================================================================== --- hadoop/zookeeper/trunk/CHANGES.txt (original) +++ hadoop/zookeeper/trunk/CHANGES.txt Thu Jan 8 13:40:55 2009 @@ -97,6 +97,9 @@ ZOOKEEPER-214. add new "stat reset" command to server admin port. (pat via mahadev) + ZOOKEEPER-258. docs incorrectly state max client timeout as 60 seconds +(it's based on server ticktime). (phunt via mahadev) + Release 3.0.0 - 2008-10-21 Non-backward compatible changes: Modified: hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html?rev=732831&r1=732830&r2=732831&view=diff ============================================================================== --- hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html (original) +++ hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html Thu Jan 8 13:40:55 2009 @@ -733,28 +733,32 @@ <a name="N101A5"></a><a name="ch_zkSessions"></a> <h2 class="h3">ZooKeeper Sessions</h2> <div class="section"> -<p>When a client gets a handle to the ZooKeeper service, ZooKeeper - creates a ZooKeeper session, represented as a 64-bit number, that it - assigns to the client. If the client connects to a different ZooKeeper - server, it will send the session id as a part of the connection handshake. - As a security measure, the server creates a password for the session id - that any ZooKeeper server can validate.The password is sent to the client with the session id when the - client establishes the session. The client sends this password with the - session id whenever it reestablishes the session with a new server.</p> -<p>One of the parameters to the ZooKeeper client library call to create - a ZooKeeper session is the session timeout in milliseconds. The client - sends a requested timeout, the server responds with the timeout that it - can give the client. The current implementation requires that the timeout - be between 2 times the tickTime (as set in the server configuration) and - 60 seconds.</p> -<p>The session is kept alive by requests sent by the client. If the - session is idle for a period of time that would timeout the session, the - client will send a PING request to keep the session alive. This PING - request not only allows the ZooKeeper server to know that the client is - still active, but it also allows the client to verify that its connection - to the ZooKeeper server is still active. The timing of the PING is - conservative enough to ensure reasonable time to detect a dead connection - and reconnect to a new server.</p> +<p>When a client gets a handle to the ZooKeeper service, + ZooKeeper creates a ZooKeeper session, represented as a 64-bit + number, that it assigns to the client. If the client connects to a + different ZooKeeper server, it will send the session id as a part + of the connection handshake. As a security measure, the server + creates a password for the session id that any ZooKeeper server + can validate.The password is sent to the client with the session + id when the client establishes the session. The client sends this + password with the session id whenever it reestablishes the session + with a new server.</p> +<p>One of the parameters to the ZooKeeper client library call + to create a ZooKeeper session is the session timeout in + milliseconds. The client sends a requested timeout, the server + responds with the timeout that it can give the client. The current + implementation requires that the timeout be a minimum of 2 times + the tickTime (as set in the server configuration) and a maximum of + 20 times the tickTime.</p> +<p>The session is kept alive by requests sent by the client. If + the session is idle for a period of time that would timeout the + session, the client will send a PING request to keep the session + alive. This PING request not only allows the ZooKeeper server to + know that the client is still active, but it also allows the + client to verify that its connection to the ZooKeeper server is + still active. The timing of the PING is conservative enough to + ensure reasonable time to detect a dead connection and reconnect + to a new server.</p> </div> Modified: hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperProgrammers.pdf?rev=732831&r1=732830&r2=732831&view=diff ============================================================================== Binary files - no diff available. Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml?rev=732831&r1=732830&r2=732831&view=diff ============================================================================== --- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml (original) +++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Thu Jan 8 13:40:55 2009 @@ -358,30 +358,34 @@ <section id="ch_zkSessions"> <title>ZooKeeper Sessions</title> - <para>When a client gets a handle to the ZooKeeper service, ZooKeeper - creates a ZooKeeper session, represented as a 64-bit number, that it - assigns to the client. If the client connects to a different ZooKeeper - server, it will send the session id as a part of the connection handshake. - As a security measure, the server creates a password for the session id - that any ZooKeeper server can validate.The password is sent to the client with the session id when the - client establishes the session. The client sends this password with the - session id whenever it reestablishes the session with a new server.</para> - - <para>One of the parameters to the ZooKeeper client library call to create - a ZooKeeper session is the session timeout in milliseconds. The client - sends a requested timeout, the server responds with the timeout that it - can give the client. The current implementation requires that the timeout - be between 2 times the tickTime (as set in the server configuration) and - 60 seconds.</para> - - <para>The session is kept alive by requests sent by the client. If the - session is idle for a period of time that would timeout the session, the - client will send a PING request to keep the session alive. This PING - request not only allows the ZooKeeper server to know that the client is - still active, but it also allows the client to verify that its connection - to the ZooKeeper server is still active. The timing of the PING is - conservative enough to ensure reasonable time to detect a dead connection - and reconnect to a new server.</para> + <para>When a client gets a handle to the ZooKeeper service, + ZooKeeper creates a ZooKeeper session, represented as a 64-bit + number, that it assigns to the client. If the client connects to a + different ZooKeeper server, it will send the session id as a part + of the connection handshake. As a security measure, the server + creates a password for the session id that any ZooKeeper server + can validate.The password is sent to the client with the session + id when the client establishes the session. The client sends this + password with the session id whenever it reestablishes the session + with a new server.</para> + + <para>One of the parameters to the ZooKeeper client library call + to create a ZooKeeper session is the session timeout in + milliseconds. The client sends a requested timeout, the server + responds with the timeout that it can give the client. The current + implementation requires that the timeout be a minimum of 2 times + the tickTime (as set in the server configuration) and a maximum of + 20 times the tickTime.</para> + + <para>The session is kept alive by requests sent by the client. If + the session is idle for a period of time that would timeout the + session, the client will send a PING request to keep the session + alive. This PING request not only allows the ZooKeeper server to + know that the client is still active, but it also allows the + client to verify that its connection to the ZooKeeper server is + still active. The timing of the PING is conservative enough to + ensure reasonable time to detect a dead connection and reconnect + to a new server.</para> </section> <section id="ch_zkWatches">