Struct gdnative::WebRTCDataChannel

pub struct WebRTCDataChannel { /* fields omitted */ }

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

WebRTCDataChannel inherits methods from:

• PacketPeer
• Reference
• Object

Methods

impl WebRTCDataChannel

Constants

pub const WRITE_MODE_BINARY: i64

pub const STATE_CLOSING: i64

pub const STATE_CLOSED: i64

pub const STATE_OPEN: i64

pub const WRITE_MODE_TEXT: i64

pub const STATE_CONNECTING: i64

impl WebRTCDataChannel

pub fn new_ref(&self) -> WebRTCDataChannel

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

pub fn close(&mut self)

pub fn get_id(&self) -> i64

pub fn get_label(&self) -> GodotString

pub fn get_max_packet_life_time(&self) -> i64

pub fn get_max_retransmits(&self) -> i64

pub fn get_protocol(&self) -> GodotString

pub fn get_ready_state(&self) -> WebRTCDataChannelChannelState

pub fn get_write_mode(&self) -> WebRTCDataChannelWriteMode

pub fn is_negotiated(&self) -> bool

pub fn is_ordered(&self) -> bool

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

pub fn set_write_mode(&mut self, write_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 WebRTCDataChannel

fn clone(&self) -> WebRTCDataChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebRTCDataChannel

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

Formats the value using the given formatter.

impl Deref for WebRTCDataChannel

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for WebRTCDataChannel

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

Mutably dereferences the value.

impl Drop for WebRTCDataChannel

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WebRTCDataChannel

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

impl GodotObject for WebRTCDataChannel

fn class_name() -> &'static str

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

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

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

impl ToVariant for WebRTCDataChannel

fn to_variant(&self) -> Variant