Struct gdnative::api::WebSocketClient

pub struct WebSocketClient { /* fields omitted */ }

core class WebSocketClient 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

WebSocketClient 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 WebSocketClient

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

Creates a new instance of this object.

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

pub fn connect_to_url(
    &self,
    url: impl Into<GodotString>,
    protocols: TypedArray<GodotString>,
    gd_mp_api: bool,
    custom_headers: TypedArray<GodotString>
) -> Result<(), GodotError>

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

pub fn get_connected_host(&self) -> GodotString

pub fn get_connected_port(&self) -> i64

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

pub fn is_verify_ssl_enabled(&self) -> bool

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

pub fn set_verify_ssl_enabled(&self, enabled: bool)

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
) -> Result<(), GodotError>

Trait Implementations

impl Debug for WebSocketClient

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

Formats the value using the given formatter.

impl Deref for WebSocketClient

type Target = WebSocketMultiplayerPeer

The resulting type after dereferencing.

fn deref(&self) -> &WebSocketMultiplayerPeer

Dereferences the value.

impl DerefMut for WebSocketClient

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

Mutably dereferences the value.

impl GodotObject for WebSocketClient

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 WebSocketClient

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

impl SubClass<NetworkedMultiplayerPeer> for WebSocketClient

impl SubClass<Object> for WebSocketClient

impl SubClass<PacketPeer> for WebSocketClient

impl SubClass<Reference> for WebSocketClient

impl SubClass<WebSocketMultiplayerPeer> for WebSocketClient