Struct gdnative_bindings::WebSocketServer

pub struct WebSocketServer { /* fields omitted */ }

core class WebSocketServer inherits WebSocketMultiplayerPeer (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

WebSocketServer inherits methods from:

• WebSocketMultiplayerPeer
• 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 WebSocketServer

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

Creates a new instance of this object.

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

pub fn disconnect_peer(
    &self,
    id: i64,
    code: i64,
    reason: impl Into<GodotString>
)

pub fn bind_ip(&self) -> GodotString

pub fn ca_chain(&self) -> Option<Ref<X509Certificate, Shared>>

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

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

pub fn private_key(&self) -> Option<Ref<CryptoKey, Shared>>

pub fn ssl_certificate(&self) -> Option<Ref<X509Certificate, Shared>>

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

pub fn is_listening(&self) -> bool

pub fn listen(
    &self,
    port: i64,
    protocols: StringArray,
    gd_mp_api: bool
) -> GodotResult

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

pub fn set_ca_chain(&self, arg0: impl AsArg<X509Certificate>)

pub fn set_private_key(&self, arg0: impl AsArg<CryptoKey>)

pub fn set_ssl_certificate(&self, arg0: impl AsArg<X509Certificate>)

pub fn stop(&self)

Methods from Deref<Target = WebSocketMultiplayerPeer>

pub fn get_peer(&self, peer_id: i64) -> Option<Ref<WebSocketPeer, Shared>>

pub fn set_buffers(
    &self,
    input_buffer_size_kb: i64,
    input_max_packets: i64,
    output_buffer_size_kb: i64,
    output_max_packets: i64
) -> GodotResult

Trait Implementations

impl Debug for WebSocketServer

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

Formats the value using the given formatter.

impl Deref for WebSocketServer

type Target = WebSocketMultiplayerPeer

The resulting type after dereferencing.

fn deref(&self) -> &WebSocketMultiplayerPeer

Dereferences the value.

impl DerefMut for WebSocketServer

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

Mutably dereferences the value.

impl GodotObject for WebSocketServer

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 WebSocketServer

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

impl Sealed for WebSocketServer

impl SubClass<NetworkedMultiplayerPeer> for WebSocketServer

impl SubClass<Object> for WebSocketServer

impl SubClass<PacketPeer> for WebSocketServer

impl SubClass<Reference> for WebSocketServer

impl SubClass<WebSocketMultiplayerPeer> for WebSocketServer