PacketPeer¶
Inherited By: PacketPeerStream, PacketPeerUDP, NetworkedMultiplayerPeer
Category: Core
Brief Description¶
Abstraction and base class for packet-based protocols.
Member Functions¶
| int | get_available_packet_count ( ) const |
| PoolByteArray | get_packet ( ) const |
| int | get_packet_error ( ) const |
| Variant | get_var ( ) const |
| bool | is_object_decoding_allowed ( ) const |
| int | put_packet ( PoolByteArray buffer ) |
| int | put_var ( Variant var ) |
| void | set_allow_object_decoding ( bool enable ) |
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.
- PoolByteArray get_packet ( ) const
Get a raw packet.
- int 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.
- bool is_object_decoding_allowed ( ) const
- int put_packet ( PoolByteArray buffer )
Send a raw packet.
Send a Variant as a packet.
- void set_allow_object_decoding ( bool enable )