Struct gdnative::WebSocketServer

pub struct WebSocketServer { /* fields omitted */ }

core class WebSocketServer 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.

Class hierarchy

WebSocketServer inherits methods from:

• WebSocketMultiplayerPeer
• NetworkedMultiplayerPeer
• PacketPeer
• Reference
• Object

Methods

impl WebSocketServer

pub fn new() -> WebSocketServer

pub fn new_ref(&self) -> WebSocketServer

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

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

pub fn get_peer_address(&self, id: i64) -> GodotString

pub fn get_peer_port(&self, id: i64) -> i64

pub fn has_peer(&self, id: i64) -> bool

pub fn is_listening(&self) -> bool

pub fn listen(
    &mut self,
    port: i64,
    protocols: StringArray,
    gd_mp_api: bool
) -> Result<(), GodotError>

pub fn stop(&mut self)

pub fn to_web_socket_multiplayer_peer(&self) -> WebSocketMultiplayerPeer

Up-cast.

pub fn to_networked_multiplayer_peer(&self) -> NetworkedMultiplayerPeer

Up-cast.

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

pub fn new_ref(&self) -> WebSocketMultiplayerPeer

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

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

pub fn to_networked_multiplayer_peer(&self) -> NetworkedMultiplayerPeer

Up-cast.

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.

Trait Implementations

impl Clone for WebSocketServer

fn clone(&self) -> WebSocketServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketServer

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

Formats the value using the given formatter.

impl Deref for WebSocketServer

type Target = WebSocketMultiplayerPeer

The resulting type after dereferencing.

fn deref(&self) -> &WebSocketMultiplayerPeer

Dereferences the value.

impl DerefMut for WebSocketServer

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

Mutably dereferences the value.

impl Drop for WebSocketServer

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WebSocketServer

fn from_variant(variant: &Variant) -> Option<WebSocketServer>

impl GodotObject for WebSocketServer

fn class_name() -> &'static str

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

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

impl Instanciable for WebSocketServer

fn construct() -> WebSocketServer

impl ToVariant for WebSocketServer

fn to_variant(&self) -> Variant