Skip to content

Sender

veltix.network.sender.Sender

Handles sending data over TCP connections.

Can operate in CLIENT mode (single server connection) or SERVER mode (multiple client connections).

__init__

__init__(mode: Union[Mode, str], conn: Optional[BaseSocket] = None) -> None

Initialize the sender.

Parameters:

Name Type Description Default
mode Union[Mode, str]

Operating mode (SERVER or CLIENT)

required
conn Optional[BaseSocket]

Socket connection (required for CLIENT mode)

None

Raises:

Type Description
SenderError

If CLIENT mode without connection

send

send(data: Request, client: Optional[BaseSocket] = None) -> bool

Send a request to a client or server.

Parameters:

Name Type Description Default
data Request

Request object to send.

required
client Optional[BaseSocket]

Target client socket (required for SERVER mode, ignored for CLIENT).

None

Returns:

Type Description
bool

True if send succeeded, False otherwise.

broadcast

broadcast(data: Request, list_of_client: list[BaseSocket], except_clients: Optional[list[BaseSocket]] = None) -> bool

Broadcast data to multiple clients (SERVER mode only).

Parameters:

Name Type Description Default
data Request

Request object to broadcast.

required
list_of_client list[BaseSocket]

List of client sockets to send to.

required
except_clients Optional[list[BaseSocket]]

List of client sockets to exclude from broadcast.

None

Returns:

Type Description
bool

True if ALL sends succeeded, False if ANY failed.