Abstraction and base class for packet-based protocols.
|int||get_available_packet_count ( ) const|
|PoolByteArray||get_packet ( )|
|Error||get_packet_error ( ) const|
|Variant||get_var ( )|
|Error||put_packet ( PoolByteArray buffer )|
|Error||put_var ( Variant var )|
PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering.
Member Function Description¶
- int get_available_packet_count ( ) const
Return the number of packets currently available in the ring-buffer.
- PoolByteArray get_packet ( )
Get a raw packet.
- Error get_packet_error ( ) const
- Variant get_var ( )
Get a Variant.
Send a raw packet.
Send a Variant as a packet.