Struct gdnative::api::TCP_Server

pub struct TCP_Server { /* fields omitted */ }

core class TCP_Server inherits Reference (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

TCP_Server inherits methods from:

• Reference
• Object

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 TCP_Server

pub fn new() -> Ref<TCP_Server, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn is_connection_available(&self) -> bool

Returns [code]true[/code] if a connection is available for taking.

pub fn is_listening(&self) -> bool

Returns [code]true[/code] if the server is currently listening for connections.

pub fn listen(
    &self,
    port: i64,
    bind_address: impl Into<GodotString>
) -> Result<(), GodotError>

Listen on the [code]port[/code] binding to [code]bind_address[/code].
				If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6).
				If [code]bind_address[/code] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type.
				If [code]bind_address[/code] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).

Default Arguments

• bind_address - "*"

pub fn stop(&self)

Stops listening.

pub fn take_connection(&self) -> Option<Ref<StreamPeerTCP, Shared>>

If a connection is available, returns a StreamPeerTCP with the connection.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for TCP_Server

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

Formats the value using the given formatter.

impl Deref for TCP_Server

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for TCP_Server

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

Mutably dereferences the value.

impl GodotObject for TCP_Server

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.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for TCP_Server

fn construct() -> Ref<TCP_Server, Unique>

impl SubClass<Object> for TCP_Server

impl SubClass<Reference> for TCP_Server