[][src]Struct gdnative_network::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.

Feature flag

This type is behind the gdnative crate's network feature flag.

Class hierarchy

WebSocketClient inherits methods from:

Methods

impl WebSocketClient[src]

pub fn new() -> Self[src]

pub fn new_ref(&self) -> Self[src]

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
) -> GodotResult
[src]

pub fn disconnect_from_host(&mut self)[src]

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

pub fn is_verify_ssl_enabled(&self) -> bool[src]

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

Inherited from WebSocketMultiplayerPeer.

pub fn set_transfer_mode(&mut self, mode: i64)[src]

Inherited from NetworkedMultiplayerPeer.

pub fn get_transfer_mode(&self) -> NetworkedMultiplayerPeerTransferMode[src]

Inherited from NetworkedMultiplayerPeer.

pub fn set_target_peer(&mut self, id: i64)[src]

Inherited from NetworkedMultiplayerPeer.

pub fn get_packet_peer(&self) -> i64[src]

Inherited from NetworkedMultiplayerPeer.

pub fn poll(&mut self)[src]

Inherited from NetworkedMultiplayerPeer.

pub fn get_connection_status(&self) -> NetworkedMultiplayerPeerConnectionStatus[src]

Inherited from NetworkedMultiplayerPeer.

pub fn get_unique_id(&self) -> i64[src]

Inherited from NetworkedMultiplayerPeer.

pub fn set_refuse_new_connections(&mut self, enable: bool)[src]

Inherited from NetworkedMultiplayerPeer.

pub fn is_refusing_new_connections(&self) -> bool[src]

Inherited from NetworkedMultiplayerPeer.

pub fn get_var(&mut self) -> Variant[src]

Inherited from PacketPeer.

pub fn put_var(&mut self, var: Variant) -> GodotResult[src]

Inherited from PacketPeer.

pub fn get_packet(&mut self) -> ByteArray[src]

Inherited from PacketPeer.

pub fn put_packet(&mut self, buffer: ByteArray) -> GodotResult[src]

Inherited from PacketPeer.

pub fn get_packet_error(&self) -> GodotResult[src]

Inherited from PacketPeer.

pub fn get_available_packet_count(&self) -> i64[src]

Inherited from PacketPeer.

pub fn set_allow_object_decoding(&mut self, enable: bool)[src]

Inherited from PacketPeer.

pub fn is_object_decoding_allowed(&self) -> bool[src]

Inherited from PacketPeer.

pub fn init_ref(&mut self) -> bool[src]

Inherited from Reference.

pub fn _notification(&mut self, what: i64)[src]

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool[src]

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant[src]

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray[src]

Inherited from Object.

pub fn _init(&mut self)[src]

Inherited from Object.

pub fn get_class(&self) -> GodotString[src]

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool[src]

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)[src]

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant[src]

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)[src]

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant[src]

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)[src]

Inherited from Object.

pub fn get_instance_id(&self) -> i64[src]

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)[src]

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>[src]

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)[src]

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant[src]

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool[src]

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray[src]

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)[src]

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool[src]

Inherited from Object.

pub fn emit_signal(
    &mut self,
    signal: GodotString,
    varargs: &[Variant]
) -> Variant
[src]

Inherited from Object.

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant[src]

Inherited from Object.

pub fn call_deferred(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant
[src]

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant[src]

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool[src]

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray[src]

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray[src]

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray[src]

Inherited from Object.

pub fn connect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString,
    binds: VariantArray,
    flags: i64
) -> GodotResult
[src]

Inherited from Object.

pub fn disconnect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
)
[src]

Inherited from Object.

pub fn is_connected(
    &self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
) -> bool
[src]

Inherited from Object.

pub fn set_block_signals(&mut self, enable: bool)[src]

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool[src]

Inherited from Object.

pub fn property_list_changed_notify(&mut self)[src]

Inherited from Object.

pub fn set_message_translation(&mut self, enable: bool)[src]

Inherited from Object.

pub fn can_translate_messages(&self) -> bool[src]

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString[src]

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool[src]

Inherited from Object.

pub fn to_web_socket_multiplayer_peer(&self) -> WebSocketMultiplayerPeer[src]

Up-cast.

pub fn to_networked_multiplayer_peer(&self) -> NetworkedMultiplayerPeer[src]

Up-cast.

pub fn to_packet_peer(&self) -> PacketPeer[src]

Up-cast.

pub fn to_reference(&self) -> Reference[src]

Up-cast.

pub fn to_object(&self) -> Object[src]

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>[src]

Generic dynamic cast.

Trait Implementations

impl Debug for WebSocketClient[src]

impl Drop for WebSocketClient[src]

impl GodotObject for WebSocketClient[src]

impl ToVariant for WebSocketClient[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.