Struct gdnative::WebSocketPeer

pub struct WebSocketPeer { /* fields omitted */ }

core class WebSocketPeer inherits PacketPeer (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

WebSocketPeer inherits methods from:

• PacketPeer
• Reference
• Object

Methods

impl WebSocketPeer

Constants

pub const WRITE_MODE_BINARY: i64

pub const WRITE_MODE_TEXT: i64

impl WebSocketPeer

pub fn new() -> WebSocketPeer

pub fn new_ref(&self) -> WebSocketPeer

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

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

pub fn get_connected_host(&self) -> GodotString

pub fn get_connected_port(&self) -> i64

pub fn get_write_mode(&self) -> WebSocketPeerWriteMode

pub fn is_connected_to_host(&self) -> bool

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

pub fn set_write_mode(&mut self, mode: i64)

pub fn was_string_packet(&self) -> bool

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 = PacketPeer>

pub fn new_ref(&self) -> PacketPeer

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

pub fn get_available_packet_count(&self) -> i64

pub fn get_encode_buffer_max_size(&self) -> i64

pub fn get_packet(&mut self) -> ByteArray

pub fn get_packet_error(&self) -> Result<(), GodotError>

pub fn get_var(&mut self, allow_objects: bool) -> Variant

pub fn is_object_decoding_allowed(&self) -> bool

pub fn put_packet(&mut self, buffer: ByteArray) -> Result<(), GodotError>

pub fn put_var(
    &mut self,
    var: Variant,
    full_objects: bool
) -> Result<(), GodotError>

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

pub fn set_encode_buffer_max_size(&mut self, max_size: i64)

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

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 WebSocketPeer

fn clone(&self) -> WebSocketPeer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketPeer

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

Formats the value using the given formatter.

impl Deref for WebSocketPeer

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for WebSocketPeer

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

Mutably dereferences the value.

impl Drop for WebSocketPeer

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WebSocketPeer

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

impl GodotObject for WebSocketPeer

fn class_name() -> &'static str

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

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

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

impl Instanciable for WebSocketPeer

fn construct() -> WebSocketPeer

impl ToVariant for WebSocketPeer

fn to_variant(&self) -> Variant