Struct ENetConnection

pub struct ENetConnection { /* private fields */ }

Expand description

Godot class ENetConnection.

Inherits RefCounted.

Related symbols:

enet_connection: sidecar module with related enum/flag types
IENetConnection: virtual methods

§Construction

This class is reference-counted. You can create a new instance using ENetConnection::new_gd().

§Godot docs

ENet’s purpose is to provide a relatively thin, simple and robust network communication layer on top of UDP (User Datagram Protocol).

Implementations§

§

impl ENetConnection

pub fn create_host_bound( &mut self, bind_address: impl AsArg<GString>, bind_port: i32, ) -> Error

To set the default parameters, use create_host_bound_ex and its builder methods. See the book for detailed usage instructions. Creates an ENetHost bound to the given bind_address and bind_port that allows up to max_peers connected peers, each allocating up to max_channels channels, optionally limiting bandwidth to in_bandwidth and out_bandwidth (if greater than zero).

Note: It is necessary to create a host in both client and server in order to establish a connection.

pub fn create_host_bound_ex<'ex>( &'ex mut self, bind_address: impl AsArg<GString> + 'ex, bind_port: i32, ) -> ExCreateHostBound<'ex>

Creates an ENetHost bound to the given bind_address and bind_port that allows up to max_peers connected peers, each allocating up to max_channels channels, optionally limiting bandwidth to in_bandwidth and out_bandwidth (if greater than zero).

Note: It is necessary to create a host in both client and server in order to establish a connection.

pub fn create_host(&mut self) -> Error

To set the default parameters, use create_host_ex and its builder methods. See the book for detailed usage instructions. Creates an ENetHost that allows up to max_peers connected peers, each allocating up to max_channels channels, optionally limiting bandwidth to in_bandwidth and out_bandwidth (if greater than zero).

This method binds a random available dynamic UDP port on the host machine at the unspecified address. Use create_host_bound to specify the address and port.

Note: It is necessary to create a host in both client and server in order to establish a connection.

pub fn create_host_ex<'ex>(&'ex mut self) -> ExCreateHost<'ex>

Creates an ENetHost that allows up to max_peers connected peers, each allocating up to max_channels channels, optionally limiting bandwidth to in_bandwidth and out_bandwidth (if greater than zero).

This method binds a random available dynamic UDP port on the host machine at the unspecified address. Use create_host_bound to specify the address and port.

Note: It is necessary to create a host in both client and server in order to establish a connection.

pub fn destroy(&mut self)

Destroys the host and all resources associated with it.

pub fn connect_to_host( &mut self, address: impl AsArg<GString>, port: i32, ) -> Option<Gd<ENetPacketPeer>>

To set the default parameters, use connect_to_host_ex and its builder methods. See the book for detailed usage instructions. Initiates a connection to a foreign address using the specified port and allocating the requested channels. Optional data can be passed during connection in the form of a 32 bit integer.

Note: You must call either create_host or create_host_bound on both ends before calling this method.

pub fn connect_to_host_ex<'ex>( &'ex mut self, address: impl AsArg<GString> + 'ex, port: i32, ) -> ExConnectToHost<'ex>

Initiates a connection to a foreign address using the specified port and allocating the requested channels. Optional data can be passed during connection in the form of a 32 bit integer.

Note: You must call either create_host or create_host_bound on both ends before calling this method.

pub fn service(&mut self) -> Array<Variant>

To set the default parameters, use service_ex and its builder methods. See the book for detailed usage instructions. Waits for events on this connection and shuttles packets between the host and its peers, with the given timeout (in milliseconds). The returned Array will have 4 elements. An [enum EventType], the ENetPacketPeer which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is EventType::RECEIVE, the received packet will be queued to the associated ENetPacketPeer.

Call this function regularly to handle connections, disconnections, and to receive new packets.

Note: This method must be called on both ends involved in the event (sending and receiving hosts).

pub fn service_ex<'ex>(&'ex mut self) -> ExService<'ex>

Waits for events on this connection and shuttles packets between the host and its peers, with the given timeout (in milliseconds). The returned Array will have 4 elements. An [enum EventType], the ENetPacketPeer which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is EventType::RECEIVE, the received packet will be queued to the associated ENetPacketPeer.

Call this function regularly to handle connections, disconnections, and to receive new packets.

Note: This method must be called on both ends involved in the event (sending and receiving hosts).

pub fn flush(&mut self)

Sends any queued packets on the host specified to its designated peers.

pub fn bandwidth_limit(&mut self)

To set the default parameters, use bandwidth_limit_ex and its builder methods. See the book for detailed usage instructions. Adjusts the bandwidth limits of a host.

pub fn bandwidth_limit_ex<'ex>(&'ex mut self) -> ExBandwidthLimit<'ex>

Adjusts the bandwidth limits of a host.

pub fn channel_limit(&mut self, limit: i32)

Limits the maximum allowed channels of future incoming connections.

pub fn broadcast(&mut self, channel: i32, packet: &PackedArray<u8>, flags: i32)

Queues a packet to be sent to all peers associated with the host over the specified channel. See ENetPacketPeer FLAG_* constants for available packet flags.

pub fn compress(&mut self, mode: CompressionMode)

Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all.

Note: Most games’ network design involve sending many small packets frequently (smaller than 4 KB each). If in doubt, it is recommended to keep the default compression algorithm as it works best on these small packets.

Note: The compression mode must be set to the same value on both the server and all its clients. Clients will fail to connect if the compression mode set on the client differs from the one set on the server.

pub fn dtls_server_setup( &mut self, server_options: impl AsArg<Option<Gd<TlsOptions>>>, ) -> Error

Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet servers. Call this right after create_host_bound to have ENet expect peers to connect using DTLS. See server.

pub fn dtls_client_setup(&mut self, hostname: impl AsArg<GString>) -> Error

To set the default parameters, use dtls_client_setup_ex and its builder methods. See the book for detailed usage instructions. Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before connect_to_host to have ENet connect using DTLS validating the server certificate against hostname. You can pass the optional client_options parameter to customize the trusted certification authorities, or disable the common name verification. See client and client_unsafe.

pub fn dtls_client_setup_ex<'ex>( &'ex mut self, hostname: impl AsArg<GString> + 'ex, ) -> ExDtlsClientSetup<'ex>

Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before connect_to_host to have ENet connect using DTLS validating the server certificate against hostname. You can pass the optional client_options parameter to customize the trusted certification authorities, or disable the common name verification. See client and client_unsafe.

pub fn refuse_new_connections(&mut self, refuse: bool)

Configures the DTLS server to automatically drop new connections.

Note: This method is only relevant after calling dtls_server_setup.

pub fn pop_statistic(&mut self, statistic: HostStatistic) -> f64

Returns and resets host statistics.

pub fn get_max_channels(&self) -> i32

Returns the maximum number of channels allowed for connected peers.

pub fn get_local_port(&self) -> i32

Returns the local port to which this peer is bound.

pub fn get_peers(&self) -> Array<Gd<ENetPacketPeer>>

Returns the list of peers associated with this host.

Note: This list might include some peers that are not fully connected or are still being disconnected.

pub fn socket_send( &mut self, destination_address: impl AsArg<GString>, destination_port: i32, packet: &PackedArray<u8>, )

Sends a packet toward a destination from the address and port currently bound by this ENetConnection instance.

This is useful as it serves to establish entries in NAT routing tables on all devices between this bound instance and the public facing internet, allowing a prospective client’s connection packets to be routed backward through the NAT device(s) between the public internet and this host.

This requires forward knowledge of a prospective client’s address and communication port as seen by the public internet - after any NAT devices have handled their connection request. This information can be obtained by a STUN service, and must be handed off to your host by an entity that is not the prospective client. This will never work for a client behind a Symmetric NAT due to the nature of the Symmetric NAT routing algorithm, as their IP and Port cannot be known beforehand.

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Returns the current reference count.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.

Note: A metadata’s name must be a valid identifier as per is_valid_identifier method.