tornadio2.proto¶
tornadio2.proto¶
Socket.IO protocol related functions
Packets¶
-
tornadio2.proto.disconnect(endpoint=None)[source]¶ Generate disconnect packet.
- endpoint
- Optional endpoint name
-
tornadio2.proto.connect(endpoint=None)[source]¶ Generate connect packet.
- endpoint
- Optional endpoint name
-
tornadio2.proto.message(endpoint, msg, message_id=None, force_json=False)[source]¶ Generate message packet.
- endpoint
- Optional endpoint name
- msg
- Message to encode. If message is ascii/unicode string, will send message packet. If object or dictionary, will json encode and send as is.
- message_id
- Optional message id for ACK
- force json
- Disregard msg type and send the message with JSON type. Usefull for already JSON encoded strings.
-
tornadio2.proto.event(endpoint, name, message_id, *args, **kwargs)[source]¶ Generate event message.
- endpoint
- Optional endpoint name
- name
- Event name
- message_id
- Optional message id for ACK
- args
- Optional event arguments.
- kwargs
- Optional event arguments. Will be encoded as dictionary.
-
tornadio2.proto.ack(endpoint, message_id, ack_response=None)[source]¶ Generate ACK packet.
- endpoint
- Optional endpoint name
- message_id
- Message id to acknowledge
- ack_response
- Acknowledgment response data (will be json serialized)