Struct client::GameplaySocket

pub struct GameplaySocket {
    pub debug_max_message_length: usize,
    /* private fields */
}

Wrapper around UDP and TCP sockets for communicating with the game server.

Implementation details

TCP is only used for the initial login, which is encrypted with TLS. The root certificate is built into the client. The following gameplay updates are sent over UDP, encrypted with ChaCha20-Poly1305, using a secret shared during the login process. The UDP messages are processed with MessageOrderer to make sure they arrive, and that are processed in order.

Fields

debug_max_message_length: usize

Implementations

impl GameplaySocket

pub fn new() -> Result<GameplaySocket>

Connects to the game’s login servers and sets up the communication channel. GameplaySocket::transport should be called periodically (many times a second) afterwards, to transport sent messages, as well as keepalive messages.

pub fn disconnected(&self) -> bool

Returns true after it’s been common::protocol::DISCONNECT_THRESHOLD since the last packet from the server.

pub fn transport(&mut self)

Sends and receives all pending messages on the UDP socket.

pub fn send(&mut self, action: ClientAction)

Queues the ClientAction for sending during the next GameplaySocket::transport.

pub fn recv(&mut self) -> Option<ServerAction>

Returns any ServerActions received during previously called GameplaySocket::transports.