PacketPeer

Abstraction and base class for packet-based protocols.

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.

@GodotBaseClass

struct PacketPeer {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(PacketPeer other);

PacketPeer opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static PacketPeer _new();

Variant getVar();

GodotError putVar(VariantArg0 var);

PoolByteArray getPacket();

GodotError putPacket(PoolByteArray buffer);

GodotError getPacketError();

long getAvailablePacketCount();

void setAllowObjectDecoding(bool enable);

bool isObjectDecodingAllowed();

bool allowObjectDecoding [@property getter];

bool allowObjectDecoding [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getAvailablePacketCount long getAvailablePacketCount(): Return the number of packets currently available in the ring-buffer.
getPacket PoolByteArray getPacket(): Get a raw packet.
getPacketError GodotError getPacketError(): Return the error state of the last packet received (via getPacket and getVar).
getVar Variant getVar(): Get a Variant.
isObjectDecodingAllowed bool isObjectDecodingAllowed()
opAssign PacketPeer opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(PacketPeer other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
putPacket GodotError putPacket(PoolByteArray buffer): Send a raw packet.
putVar GodotError putVar(VariantArg0 var): Send a Variant as a packet.
setAllowObjectDecoding void setAllowObjectDecoding(bool enable)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

allowObjectDecoding bool allowObjectDecoding [@property getter]
bool allowObjectDecoding [@property setter]

Static functions

_new PacketPeer _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

PacketPeer

Members

Aliases

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

PacketPeer

From mixin baseCasts

From `mixin baseCasts`