Struct gdnative_bindings_lily::TCP_Server [−][src]
pub struct TCP_Server { /* fields omitted */ }
Expand description
core class TCP_Server
inherits Reference
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
TCP_Server 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
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Returns true
if a connection is available for taking.
Returns true
if the server is currently listening for connections.
Listen on the port
binding to bind_address
.
If bind_address
is set as "*"
(default), the server will listen on all available addresses (both IPv4 and IPv6).
If bind_address
is set as "0.0.0.0"
(for IPv4) or "::"
(for IPv6), the server will listen on all available addresses matching that IP type.
If bind_address
is set to any valid address (e.g. "192.168.1.101"
, "::1"
, 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
-"*"
If a connection is available, returns a StreamPeerTCP with the connection.
Methods from Deref<Target = Reference>
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for TCP_Server
impl !Send for TCP_Server
impl !Sync for TCP_Server
impl Unpin for TCP_Server
impl UnwindSafe for TCP_Server