Sans-IO API Reference¶

Protocol Interface¶

The base class for handling the RCON protocol between two computers.

`berconpy.RCONClientProtocol`	Implements the client-side portion of the protocol.
`berconpy.ClientEvent`	An event produced by the `RCONClientProtocol` subclass.
`berconpy.ClientAuthEvent`	Indicates if an authentication request was successful.
`berconpy.ClientCommandEvent`	Represents the response to a given command.
`berconpy.ClientMessageEvent`	Represents a message sent by the server.
`berconpy.ClientState`	Defines the current state of the protocol.
`berconpy.RCONServerProtocol`	A Sans-IO implementation of the server RCON protocol for one client.
`berconpy.ServerEvent`	An event produced by the `RCONServerProtocol` subclass.
`berconpy.ServerAuthEvent`	Indicates if an authentication request was successful.
`berconpy.ServerCommandEvent`	Represents a command sent by the client.
`berconpy.ServerMessageEvent`	Represents an acknowledgement of a message sent by the server.
`berconpy.ServerState`	Defines the current authentication state.

`berconpy.protocol.Packet`	The base class used for all messages sent between the BattlEye RCON server and client.
`berconpy.protocol.PacketType`	The type of packet received by the server.
`berconpy.protocol.ClientPacket`	The base class for packets sent by the client.
`berconpy.protocol.ClientLoginPacket`	The packet used to log in a client.
`berconpy.protocol.ClientCommandPacket`	The packet sent by the client issuing a command to the server.
`berconpy.protocol.ClientMessagePacket`	The packet sent to acknowledge a given server message.
`berconpy.protocol.ServerPacket`	The base class used for packets sent by the server.
`berconpy.protocol.ServerLoginPacket`	The packet indicating if login was successful.
`berconpy.protocol.ServerCommandPacket`	The packet(s) sent in response to a command.
`berconpy.protocol.ServerMessagePacket`	The packet sent to share a message to the client.

`berconpy.Check`	A callable object that makes a boolean judgement about a packet.
`berconpy.NonceCheck`	A simple check that verifies the `Packet.sequence` has not been recently seen before.

The current state of the protocol does not match the expected states.