@@ -83,40 +83,42 @@ connection to the event daemon starts out in Enqueue Mode, and this is the only
8383mode from which commands can be issued.
8484.PP
8585"FALSE" may be emitted by the server if there is a syntax error.
86- .PP
86+ .SS ID
8787The command "ID <res_id>" declares the particular connection to be a notification
8888sender. res_id is generally the hostname and the PID. The server always
8989responds with "TRUE". (The connection stays in Enqueue Mode.)
90- .PP
90+ .SS LISTEN
9191The command "LISTEN <res_id>" declares the particular connection to be a
9292notification receiver. res_id follows the same pattern. The server responds
9393with "TRUE" and the connection state changes to the Dequeue Mode (see below).
94- .PP
94+ .SS SELECT
9595The command "SELECT <username> <folder>" subscribes those connections that have
9696registered \fB as a listener for res_id \fP to notifications. (This means that a
9797process wishing to use event_stub(4gx) to listen for notifications strictly
9898requires loading event_proxy(4gx) too, and, in essence, use two connections to
9999event(8gx).) The server responds with "FALSE" if no listener exists, or "TRUE"
100100on success.
101- .PP
101+ .SS UNSELECT
102102The command "UNSELECT <username> <folder>" unsubscribes those connections that
103103had registered as a listener for res_id. The server always responds with
104104"TRUE".
105- .PP
106- Auxiliary self-explanatory commands available are: "QUIT" and "PING".
107- .PP
105+ .SS QUIT
106+ Terminate the connection.
107+ .SS PING
108+ Reset inactivity timer on connection.
109+ .SS Partially parsed commands
108110Any other input is treated as a notification item and is not interpreted by
109111event(8gx) beyond checking the number of fields:
110- .PP
111- The notification "FOLDER-TOUCH <username> <folder>" informs listeners that the
112+ .SS FOLDER-TOUCH
113+ The notification "FOLDER\ - TOUCH <username> <folder>" informs listeners that the
112114folder metadata has changed and warrants being reloaded.
113- .PP
114- The notification "MESSAGE-FLAG <username> <folder> <messageid>" informs
115+ .SS MESSAGE-FLAG
116+ The notification "MESSAGE\ - FLAG <username> <folder> <messageid>" informs
115117listeners that the message metadata has changed and warrants being reloaded.
116- .PP
117- The notification "MESSAGE-EXPUNGE <username> <folder> <messageid>" informs
118+ .SS MESSAGE-EXPUNGE
119+ The notification "MESSAGE\ - EXPUNGE <username> <folder> <messageid>" informs
118120listeners that the message was deleted.
119- .PP
121+ .SS Client behavior
120122Clients in Dequeue Mode will receive notifications. Each notification line
121123received by the client needs to be acknowledged with a "TRUE" response. It is
122124not possible to exit Dequeue Mode; connection termination is the only way out.
0 commit comments