diff options
author | Mattias Andrée <maandree@operamail.com> | 2014-08-24 16:35:52 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2014-08-24 16:35:52 +0200 |
commit | dd7f18d6c2d80dbc6a1e55ee0f4f39fc68cf5c00 (patch) | |
tree | 180f66e54173cfa5574e8e2491b26a008f97b214 /doc | |
parent | derp (diff) | |
download | mds-dd7f18d6c2d80dbc6a1e55ee0f4f39fc68cf5c00.tar.gz mds-dd7f18d6c2d80dbc6a1e55ee0f4f39fc68cf5c00.tar.bz2 mds-dd7f18d6c2d80dbc6a1e55ee0f4f39fc68cf5c00.tar.xz |
info: message passing
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r-- | doc/info/mds.texinfo | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/doc/info/mds.texinfo b/doc/info/mds.texinfo index b275952..fbe2993 100644 --- a/doc/info/mds.texinfo +++ b/doc/info/mds.texinfo @@ -394,6 +394,126 @@ its servers and clients. @node Message Passing @section Message Passing +Message passing over domain sockets is the +underlaying technique for communicating with +the display server. To communicate with the +display server in the local machine a process +must connect to the domain socket created by +the display server kernel as named in +@ref{Filesystem}. + +Clients should request a unique ID when it +connects to the display server.@footnote{There +is seldom a reason for servers to do this.} +To do this the client sends + +@example +Command: assign-id\n +Message ID: 0\n +\n +@end example + +where @code{\n} is an LF-line break. +The value on the @code{Message ID} line +does not need to be 0, but servers and +clients often start with 0 and count +upwards. The value is however bound to +an unsigned 32-bit integer. All message +must contain this @code{Message ID} header, +otherwise the message is considered corrupt +and is ignored. + +The empty line signifies the end of the +header list, and in this case the end of +the message. But a message may contain +payload beneath this empty line. To +include a payload, add the header +@code{Length} that says how many bytes +the payload is comprised of. + +A header must contain a header name and +header value without any trailing or +leading spaces, and `: ' (colon, one +regular blank space) exactly delimits +the name and the value. + +When the master server receives this +@code{Command: assign-id} message it +will assign the client a unique ID +and send it to the client.@footnote{The +master server is the only server than +can address the client uniquely before +it has an ID, so this part can only +be implement in the master server.} +If the client already has an ID, it +will send back that ID to the client. +This response consists of two headers +@code{ID assignment} and @code{In +response to}, containing the client's +new (or possibly already assigned) ID +and the value that was in the +@code{Message ID} header, respectively. +For example: + +@example +ID assignment: 0:1\n +In response to: 0\n +\n +@end example + +Notice that the master server never +includes @code{Message ID} in message +originating from it. + +As seen in this example, the client ID +consists of two integers delimited by +a colon (`:'). Both of these integers +are unsigned 32-bit integers. This is +done this way because unsigned 64-bit +integers are forbidden because it is +not supportable natively be some +programming languages. + +Before a has gotten a unique client ID +assigned to it, it will be `0:0'. + +If a client gets disconnected from the +master server, the master server will +sends out a signal header message. +This header will be @code{Client closed} +and contain ID of the client that closed. +For example: + +@example +Client closed: 0:1\n +\n +@end example + +Be aware that if a server or client +closes and does not have a unique client +ID, this message will be: + +@example +Client closed: 0:0\n +\n +@end example + +Once a client has an unique client ID +assigned to it, it should always include +the header @code{Client ID} in its +messages. The value of @code{Client ID} +should be the client's ID. If a server +wants to address this client, it should +include the header @code{To} with the +value set to the recipient's client ID. +Be aware that such message may not be +sent to that recipient uniquely, any +server or client is free to sign up +for receive of such message, any messages +or message contain any other header or +header--value pair that may also be +included in the header. + @node GNU Free Documentation License |