[−][src]Struct gdnative_bindings::WebSocketPeer
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:
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 WebSocketPeer
[src]
Constants
pub const WRITE_MODE_BINARY: i64
[src]
pub const WRITE_MODE_TEXT: i64
[src]
impl WebSocketPeer
[src]
pub fn new() -> Ref<Self, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn close(&self, code: i64, reason: impl Into<GodotString>)
[src]
pub fn get_connected_host(&self) -> GodotString
[src]
pub fn get_connected_port(&self) -> i64
[src]
pub fn get_write_mode(&self) -> WriteMode
[src]
pub fn is_connected_to_host(&self) -> bool
[src]
pub fn set_no_delay(&self, enabled: bool)
[src]
pub fn set_write_mode(&self, mode: i64)
[src]
pub fn was_string_packet(&self) -> bool
[src]
Methods from Deref<Target = PacketPeer>
pub fn get_available_packet_count(&self) -> i64
[src]
Returns the number of packets currently available in the ring-buffer.
pub fn encode_buffer_max_size(&self) -> i64
[src]
Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations.
The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY].
pub fn get_packet(&self) -> ByteArray
[src]
Gets a raw packet.
pub fn get_packet_error(&self) -> GodotResult
[src]
Returns the error state of the last packet received (via [method get_packet] and [method get_var]).
pub fn get_var(&self, allow_objects: bool) -> Variant
[src]
Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed.
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
Default Arguments
allow_objects
-false
pub fn is_object_decoding_allowed(&self) -> bool
[src]
[i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead.
If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var].
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
pub fn put_packet(&self, buffer: ByteArray) -> GodotResult
[src]
Sends a raw packet.
pub fn put_var(
&self,
var: impl OwnedToVariant,
full_objects: bool
) -> GodotResult
[src]
&self,
var: impl OwnedToVariant,
full_objects: bool
) -> GodotResult
Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code).
Default Arguments
full_objects
-false
pub fn set_allow_object_decoding(&self, enable: bool)
[src]
[i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead.
If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var].
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
pub fn set_encode_buffer_max_size(&self, max_size: i64)
[src]
Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations.
The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY].
Trait Implementations
impl Debug for WebSocketPeer
[src]
impl Deref for WebSocketPeer
[src]
impl DerefMut for WebSocketPeer
[src]
fn deref_mut(&mut self) -> &mut PacketPeer
[src]
impl GodotObject for WebSocketPeer
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for WebSocketPeer
[src]
impl Sealed for WebSocketPeer
[src]
impl SubClass<Object> for WebSocketPeer
[src]
impl SubClass<PacketPeer> for WebSocketPeer
[src]
impl SubClass<Reference> for WebSocketPeer
[src]
Auto Trait Implementations
impl RefUnwindSafe for WebSocketPeer
impl !Send for WebSocketPeer
impl !Sync for WebSocketPeer
impl Unpin for WebSocketPeer
impl UnwindSafe for WebSocketPeer
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,