Author: dylan
Date: 2004-09-22 21:16:01 -0400 (Wed, 22 Sep 2004)
New Revision: 361
Modified:
trunk/docs/manual/chap/events.texi
trunk/docs/manual/chap/events/basic.texi
Log:
oh, a few words here, a few words there.
Modified: trunk/docs/manual/chap/events/basic.texi
===================================================================
--- trunk/docs/manual/chap/events/basic.texi 2004-09-17 16:42:24 UTC (rev
360)
+++ trunk/docs/manual/chap/events/basic.texi 2004-09-23 01:16:01 UTC (rev
361)
@@ -1,20 +1,21 @@
[EMAIL PROTECTED] Basic Events
[EMAIL PROTECTED] Basic Events
[EMAIL PROTECTED] Connection Events
[EMAIL PROTECTED] Connection Events
This section describes how a client connects
to the server and authenticates itself. It also
-describes how to disconnect.
+describes how to disconnect, and ways for both the server
+and client of making sure the connection is alive.
@deffn {Client Event} HAVER client
-This event must only be sent once during
-the lifetime of the connection.
-The server will not recognize the client until this event is
-sent.
+This event @strong{must} be the first event sent by the client. If a different
+event is received, servers @strong{may} immediately terminate the connection.
+
The parameter @var{client} is the name and version
number of the client software, comparable to the ``User-Agent:''
-in HTTP. The prefered format is ``Program Name/#.#.#'', where ``#''
-is a number from 0 to 9. This format is not strictly enforced.
+in HTTP. The format should be ``Program Name/#.#.#'', where ``#''
+is a number from 0 to 9. This format shall not be strictly enforced,
+but clients are encouraged to not deviate from it.
The server will respond to this event
by sending @command{HAVER} and @command{WANT IDENT}.
@@ -68,7 +69,7 @@
@c #################################
@deffn {Client Event} IDENT id [mode]
-This event must only be sent when the server requests it with @command{WANT}.
+This event @strong{must} only be sent when the server requests it with
@command{WANT}.
@var{id} is the id the client wishes to go by.
It must be in the format specified in @xref{Identifier Format}.
@@ -141,7 +142,7 @@
The parameter @var{why} is the reason for the disconnect,
such as ``lost terminal'', ``reboot'', etc.
This is not meant to be set by a human being, but instead
-the client software.
+by the client software.
@end deffn
@@ -180,3 +181,26 @@
@end table
@end deffn
+
[EMAIL PROTECTED] {Server Event} PING data
[EMAIL PROTECTED] {Client Event} PONG data
+When the server issues the @command{PING} event, the client @strong{must} reply
+with @command{PONG}. The @var{data} parameter of @command{PONG}
+is whatever value the server sent with @command{PING}.
+
[EMAIL PROTECTED] deffn
+
[EMAIL PROTECTED] {Client Event} POKE [EMAIL PROTECTED]
[EMAIL PROTECTED] {Server Event} OUCH [EMAIL PROTECTED]
+
+When the client sends @command{POKE}, the server will reply with
@command{OUCH}.
+
+There are some limits to this; in general you should not
+send this more than once a minute. Sending every five minutes is even better.
+The best method is to only send this if you haven't got an event from the
server
+in some amount of time.
+
+In spite of this warning, servers probably won't penalize you unless you send
+this every few seconds or something.
+
[EMAIL PROTECTED] deffn
Modified: trunk/docs/manual/chap/events.texi
===================================================================
--- trunk/docs/manual/chap/events.texi 2004-09-17 16:42:24 UTC (rev 360)
+++ trunk/docs/manual/chap/events.texi 2004-09-23 01:16:01 UTC (rev 361)
@@ -6,7 +6,6 @@
@end menu
@include chap/events/basic.texi
[EMAIL PROTECTED] chap/events/keepalive.texi
@ignore
\begin{cmddef}{MSG}{\param{where} \param{type} \params{msg}}
