Skip to main content

api.network.network_events

ClientConnectedEvent Objects​

@Message.define("event/network/client-connected")
class ClientConnectedEvent(Event)

Emitted whenever the Client established a connection to the server.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.

ClientDisconnectedEvent Objects​

@Message.define("event/network/client-disconnected")
class ClientDisconnectedEvent(Event)

Emitted whenever the Client cuts its connection from the server.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.

ClientConnectionErrorEvent Objects​

@Message.define("event/network/client-connection-error")
class ClientConnectionErrorEvent(Event)

Emitted whenever the Client is unable to establish a connection.

Attributes:

  • reason - The connection error reason.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          reason: str,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.

ServerConnectedEvent Objects​

@Message.define("event/network/server-connected")
class ServerConnectedEvent(Event)

Emitted whenever the Server established a connection to a client.

Attributes:

  • comp_id - The client ID.
  • client_id - The internal client ID.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          comp_id: UnitID,
          client_id: str,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.

ServerDisconnectedEvent Objects​

@Message.define("event/network/server-disconnected")
class ServerDisconnectedEvent(Event)

Emitted whenever the Server cuts a connection from a client.

Attributes:

  • comp_id - The client ID.
  • client_id - The internal client ID.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          comp_id: UnitID,
          client_id: str,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.

ServerTimeoutEvent Objects​

@Message.define("event/network/server-timeout")
class ServerTimeoutEvent(Event)

Emitted whenever the Server cuts a connection from a client due to a timeout.

Attributes:

  • comp_id - The client ID.
  • client_id - The internal client ID.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          comp_id: UnitID,
          client_id: str,
          chain: Message | None = None) -> EventComposer

Helper function to easily build this message.