Struct gdnative::api::NetworkedMultiplayerENet

pub struct NetworkedMultiplayerENet { /* fields omitted */ }

core class NetworkedMultiplayerENet inherits NetworkedMultiplayerPeer (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

NetworkedMultiplayerENet inherits methods from:

• NetworkedMultiplayerPeer
• PacketPeer
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl NetworkedMultiplayerENet

Constants

pub const COMPRESS_FASTLZ: i64

pub const COMPRESS_NONE: i64

pub const COMPRESS_RANGE_CODER: i64

pub const COMPRESS_ZLIB: i64

pub const COMPRESS_ZSTD: i64

impl NetworkedMultiplayerENet

pub fn new() -> Ref<NetworkedMultiplayerENet, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn close_connection(&self, wait_usec: i64)

pub fn create_client(
    &self,
    address: impl Into<GodotString>,
    port: i64,
    in_bandwidth: i64,
    out_bandwidth: i64,
    client_port: i64
) -> Result<(), GodotError>

pub fn create_server(
    &self,
    port: i64,
    max_clients: i64,
    in_bandwidth: i64,
    out_bandwidth: i64
) -> Result<(), GodotError>

pub fn disconnect_peer(&self, id: i64, now: bool)

pub fn channel_count(&self) -> i64

pub fn compression_mode(&self) -> CompressionMode

pub fn get_last_packet_channel(&self) -> i64

pub fn get_packet_channel(&self) -> i64

pub fn get_peer_address(&self, id: i64) -> GodotString

pub fn get_peer_port(&self, id: i64) -> i64

pub fn transfer_channel(&self) -> i64

pub fn is_always_ordered(&self) -> bool

pub fn is_dtls_enabled(&self) -> bool

pub fn is_dtls_verify_enabled(&self) -> bool

pub fn is_server_relay_enabled(&self) -> bool

pub fn set_always_ordered(&self, ordered: bool)

pub fn set_bind_ip(&self, ip: impl Into<GodotString>)

pub fn set_channel_count(&self, channels: i64)

pub fn set_compression_mode(&self, mode: i64)

pub fn set_dtls_certificate(&self, certificate: impl AsArg<X509Certificate>)

pub fn set_dtls_enabled(&self, enabled: bool)

pub fn set_dtls_key(&self, key: impl AsArg<CryptoKey>)

pub fn set_dtls_verify_enabled(&self, enabled: bool)

pub fn set_server_relay_enabled(&self, enabled: bool)

pub fn set_transfer_channel(&self, channel: i64)

Methods from Deref<Target = NetworkedMultiplayerPeer>

pub const CONNECTION_CONNECTED: i64

pub const CONNECTION_CONNECTING: i64

pub const CONNECTION_DISCONNECTED: i64

pub const TARGET_PEER_BROADCAST: i64

pub const TARGET_PEER_SERVER: i64

pub const TRANSFER_MODE_RELIABLE: i64

pub const TRANSFER_MODE_UNRELIABLE: i64

pub const TRANSFER_MODE_UNRELIABLE_ORDERED: i64

pub fn get_connection_status(&self) -> ConnectionStatus

Returns the current state of the connection. See [enum ConnectionStatus].

pub fn get_packet_peer(&self) -> i64

Returns the ID of the [NetworkedMultiplayerPeer] who sent the most recent packet.

pub fn transfer_mode(&self) -> TransferMode

The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].

pub fn get_unique_id(&self) -> i64

Returns the ID of this [NetworkedMultiplayerPeer].

pub fn is_refusing_new_connections(&self) -> bool

If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections.

pub fn poll(&self)

Waits up to 1 second to receive a new network event.

pub fn set_refuse_new_connections(&self, enable: bool)

If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections.

pub fn set_target_peer(&self, id: i64)

Sets the peer to which packets will be sent.
				The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST].

pub fn set_transfer_mode(&self, mode: i64)

The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].

Trait Implementations

impl Debug for NetworkedMultiplayerENet

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for NetworkedMultiplayerENet

type Target = NetworkedMultiplayerPeer

The resulting type after dereferencing.

fn deref(&self) -> &NetworkedMultiplayerPeer

Dereferences the value.

impl DerefMut for NetworkedMultiplayerENet

fn deref_mut(&mut self) -> &mut NetworkedMultiplayerPeer

Mutably dereferences the value.

impl GodotObject for NetworkedMultiplayerENet

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for NetworkedMultiplayerENet

fn construct() -> Ref<NetworkedMultiplayerENet, Unique>

impl SubClass<NetworkedMultiplayerPeer> for NetworkedMultiplayerENet

impl SubClass<Object> for NetworkedMultiplayerENet

impl SubClass<PacketPeer> for NetworkedMultiplayerENet

impl SubClass<Reference> for NetworkedMultiplayerENet