sul.protocol.externalconsole1.status

Packets about the informations and the usage of the server.

Members

Aliases

Packets
alias Packets = TypeTuple!(KeepAlive, UpdateNodes, RequestStats, UpdateStats)
Undocumented in source.

Classes

KeepAlive
class KeepAlive

Keeps the connection alive and/or calculates the latency. This packet should be sent at least every 5 seconds to avoid the disconnection caused by timeout and update the latency. The external console can send this packet whenever it wants it and the server must reply with the same packet with the same field's value.

RequestStats
class RequestStats

Requests an UpdateStats packet to the server, which should sent it immediately instead of waiting for the next automatic update (if the server does one).

UpdateNodes
class UpdateNodes

Updates the list of the nodes connected to the hub, adding or removing one. If the server isn't built on the hub-node layout this packet is never sent.

UpdateStats
class UpdateStats

Updates the statistics about the usage of the server and, eventually, the connected nodes. This packet is sent in response to RequestStats and every time the server retains that the stats should be updated (usually in a range of 5 to 30 seconds).

Meta