Client Protocol
CLIENT_HELLO (1)
args(dc_hash: u32, version: &str)
This is the first message a client may send. The dc_hash is a
32-bit hash value calculated from all fields/classes listed in
the client’s DC file. The version is an app/game-specific string
that developers should change whenever they release a new client
build. Both values are compared to the Client Agent’s DC file
hash and configured version string to ensure that the client is
fully up-to-date. If the client is not up-to-date, it will be
disconnected with a ClientEject. If the client is up-to-date,
the gameserver will send a ClientHelloResp to inform the
client that it may proceed with its normal logic flow.
Note
Excerpt taken from the Astron project, licensed under the BSD-3-Clause license.
Copyright © 2013 Sam “CFSworks” Edwards
Copyright © 2013 Kevin “Kestred” Stenerson
CLIENT_HELLO_RESP (2)
This is sent by the Client Agent to the client when the client’s
ClientHello is accepted. This message contains no arguments.
Note
Excerpt taken from the Astron project, licensed under the BSD-3-Clause license.
Copyright © 2013 Sam “CFSworks” Edwards
Copyright © 2013 Kevin “Kestred” Stenerson
CLIENT_DISCONNECT (3)
Sent by the client when it’s closing the connection. This message contains no arguments.
CLIENT_EJECT (4)
args(eject_code: u16, reason: &str)
This is sent by the Client Agent to the client when the client is
being disconnected. The eject_code and reason arguments
provide some explanation as to why the client is being dropped
from the game.
Eject Reasons
These are reasons sent by the Client Agent itself. As such, clients should be prepared to receive them even if nothing else in the cluster uses these codes.
106: The client sent an oversized datagram.
107: The client’s first message was not CLIENT_HELLO.
108: The client sent an invalid msgtype.
109: The client sent a truncated datagram.
113: The client violated the rules of the anonymous sandbox.
115: The client tried to send an unpermitted interest operation.
117: The client tried to manipulate a nonexistent/unseen/unknown object ID.
118: The client sent a CLIENT_OBJECT_SET_FIELD for a field they may not update.
119: The client sent a CLIENT_OBJECT_LOCATION for an object they may not relocate.
124: The client sent a CLIENT_HELLO with an invalid version string.
125: The client sent a CLIENT_HELLO with an invalid DC hash.
153: One of the client’s “session objects” has been unexpectedly deleted.
345: The client hasn’t sent a CLIENT_HEARTBEAT for an extended period of time.
347: The Client Agent had a network I/O error while trying to send a datagram.
348: The Client Agent had a network I/O error while trying to read a datagram.
Note
Excerpt taken from the Astron project, licensed under the BSD-3-Clause license.
Copyright © 2013 Sam “CFSworks” Edwards
Copyright © 2013 Kevin “Kestred” Stenerson
Cluster Eject Reasons
There are some reserved eject reason codes for the application developer to use. The Client Agent will not send eject messages with these codes. See CLIENTAGENT_EJECT for reserved codes.
CLIENT_HEARTBEAT (5)
The client should send this message on a regular interval.
If the Client Agent does not receive a ClientHeartbeat for a
certain (configurable) amount of time, it will assume that the
client has crashed and disconnect the client.
This message contains no arguments.
Note
Excerpt taken from the Astron project, licensed under the BSD-3-Clause license.
Copyright © 2013 Sam “CFSworks” Edwards
Copyright © 2013 Kevin “Kestred” Stenerson