PacketPeer¶
Inherited By: PacketPeerStream, PacketPeerUDP
Category: Core
Brief Description¶
Abstraction and base class for packet-based protocols.
Member Functions¶
| int | get_available_packet_count ( ) const |
| RawArray | get_packet ( ) const |
| Error | get_packet_error ( ) const |
| Variant | get_var ( ) const |
| Error | put_packet ( RawArray buffer ) |
| int | put_var ( Variant var ) |
Description¶
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.
- RawArray get_packet ( ) const
Get a raw packet.
- Error get_packet_error ( ) const
Return the error state of the last packet received (via get_packet and get_var).
- Variant get_var ( ) const
Get a Variant.
- Error put_packet ( RawArray buffer )
Send a raw packet.
- int put_var ( Variant var )
Send a Variant as a packet.