frost.client.socketio package

Submodules

frost.client.socketio.base_client module

class frost.client.socketio.base_client.BaseClient(ip: str = '127.0.0.1', port: int = 5555)

Bases: object

The base client to connect to a server & send and receive data.

Parameters

  • ip (str, optional) – The IP address of the server to connect to, defaults to ‘127.0.0.1’

  • port (int, optional) – The port of the server to connect to, defaults to 5555

close() → None

Close the connection to the server.

connect() → None

Connect and establish a connect to the server.

recieve() → Any

Recieve data from the server.

Returns

Data received from the server

Return type

Any

send(data: Any) → None

Send data to the server.

Parameters

data (Any) – Data to send to the server

frost.client.socketio.utils module

class frost.client.socketio.utils.threaded(*args: Any, **kwargs: Any)

Bases: object

A decorator to thread a function/method.

Module contents

class frost.client.socketio.BaseClient(ip: str = '127.0.0.1', port: int = 5555)

Bases: object

The base client to connect to a server & send and receive data.

Parameters

  • ip (str, optional) – The IP address of the server to connect to, defaults to ‘127.0.0.1’

  • port (int, optional) – The port of the server to connect to, defaults to 5555

close() → None

Close the connection to the server.

connect() → None

Connect and establish a connect to the server.

recieve() → Any

Recieve data from the server.

Returns

Data received from the server

Return type

Any

send(data: Any) → None

Send data to the server.

Parameters

data (Any) – Data to send to the server

class frost.client.socketio.threaded(*args: Any, **kwargs: Any)

Bases: object

A decorator to thread a function/method.