Struct WebSocketPeer

#[repr(C)]
pub struct WebSocketPeer { /* private fields */ }

Expand description

Godot class WebSocketPeer.

Inherits PacketPeer.

Related symbols:

web_socket_peer: sidecar module with related enum/flag types
IWebSocketPeer: virtual methods

§Construction

This class is reference-counted. You can create a new instance using WebSocketPeer::new_gd().

Implementations§

§

impl WebSocketPeer

pub fn connect_to_url(&mut self, url: impl AsArg<GString>) -> Error

To set the default parameters, use Self::connect_to_url_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_to_url_ex<'a>( &'a mut self, url: impl AsArg<GString> + 'a, ) -> ExConnectToUrl<'a>

pub fn accept_stream(&mut self, stream: impl AsObjectArg<StreamPeer>) -> Error

pub fn send(&mut self, message: &PackedByteArray) -> Error

To set the default parameters, use Self::send_ex and its builder methods. See the book for detailed usage instructions.

pub fn send_ex<'a>(&'a mut self, message: &'a PackedByteArray) -> ExSend<'a>

pub fn send_text(&mut self, message: impl AsArg<GString>) -> Error

pub fn was_string_packet(&self) -> bool

pub fn poll(&mut self)

pub fn close(&mut self)

To set the default parameters, use Self::close_ex and its builder methods. See the book for detailed usage instructions.

pub fn close_ex<'a>(&'a mut self) -> ExClose<'a>

pub fn get_connected_host(&self) -> GString

pub fn get_connected_port(&self) -> u16

pub fn get_selected_protocol(&self) -> GString

pub fn get_requested_url(&self) -> GString

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

pub fn get_current_outbound_buffered_amount(&self) -> i32

pub fn get_ready_state(&self) -> State

pub fn get_close_code(&self) -> i32

pub fn get_close_reason(&self) -> GString

pub fn get_supported_protocols(&self) -> PackedStringArray

pub fn set_supported_protocols(&mut self, protocols: &PackedStringArray)

pub fn get_handshake_headers(&self) -> PackedStringArray

pub fn set_handshake_headers(&mut self, protocols: &PackedStringArray)

pub fn get_inbound_buffer_size(&self) -> i32

pub fn set_inbound_buffer_size(&mut self, buffer_size: i32)

pub fn get_outbound_buffer_size(&self) -> i32

pub fn set_outbound_buffer_size(&mut self, buffer_size: i32)

pub fn set_max_queued_packets(&mut self, buffer_size: i32)

pub fn get_max_queued_packets(&self) -> i32

Methods from Deref<Target = PacketPeer>§

pub fn get_var(&mut self) -> Variant

To set the default parameters, use Self::get_var_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_var_ex<'a>(&'a mut self) -> ExGetVar<'a>

pub fn put_var(&mut self, var: &Variant) -> Error

To set the default parameters, use Self::put_var_ex and its builder methods. See the book for detailed usage instructions.

pub fn put_var_ex<'a>(&'a mut self, var: &'a Variant) -> ExPutVar<'a>

pub fn get_packet(&mut self) -> PackedByteArray

pub fn put_packet(&mut self, buffer: &PackedByteArray) -> Error

pub fn get_packet_error(&self) -> Error

pub fn get_available_packet_count(&self) -> i32

pub fn get_encode_buffer_max_size(&self) -> i32

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

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

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

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

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

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.