Struct gdnative::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

Methods

impl WebSocketClient

pub fn new() -> WebSocketClient

pub fn new_ref(&self) -> WebSocketClient

Creates a new reference to the same reference-counted object.

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

pub fn disconnect_from_host(&mut self, code: i64, reason: GodotString)

pub fn get_connected_host(&self) -> GodotString

pub fn get_connected_port(&self) -> i64

pub fn get_trusted_ssl_certificate(&self) -> Option<X509Certificate>

pub fn is_verify_ssl_enabled(&self) -> bool

pub fn set_trusted_ssl_certificate(&mut self, arg0: Option<X509Certificate>)

pub fn set_verify_ssl_enabled(&mut self, enabled: bool)

pub fn to_web_socket_multiplayer_peer(&self) -> WebSocketMultiplayerPeer

Up-cast.

pub fn to_networked_multiplayer_peer(&self) -> NetworkedMultiplayerPeer

Up-cast.

pub fn to_packet_peer(&self) -> PacketPeer

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = WebSocketMultiplayerPeer>

pub fn new_ref(&self) -> WebSocketMultiplayerPeer

Creates a new reference to the same reference-counted object.

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

pub fn set_buffers(
    &mut self,
    input_buffer_size_kb: i64,
    input_max_packets: i64,
    output_buffer_size_kb: i64,
    output_max_packets: i64
) -> Result<(), GodotError>

pub fn to_networked_multiplayer_peer(&self) -> NetworkedMultiplayerPeer

Up-cast.

pub fn to_packet_peer(&self) -> PacketPeer

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for WebSocketClient

fn clone(&self) -> WebSocketClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WebSocketClient

fn from_variant(variant: &Variant) -> Result<WebSocketClient, FromVariantError>

impl GodotObject for WebSocketClient

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> WebSocketClient

unsafe fn from_return_position_sys(obj: *mut c_void) -> WebSocketClient

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for WebSocketClient

fn construct() -> WebSocketClient

impl ToVariant for WebSocketClient

fn to_variant(&self) -> Variant