StreamPeerSocket ​
Inherits: StreamPeer < RefCounted < Object
Inherited By: StreamPeerTCP, StreamPeerUDS
Abstract base class for interacting with socket streams.
Description
StreamPeerSocket is an abstract base class that defines common behavior for socket-based streams.
Methods
void | |
get_status() const | |
poll() |
Enumerations
enum Status: 🔗
Status STATUS_NONE = 0
The initial status of the StreamPeerSocket. This is also the status after disconnecting.
Status STATUS_CONNECTING = 1
A status representing a StreamPeerSocket that is connecting to a host.
Status STATUS_CONNECTED = 2
A status representing a StreamPeerSocket that is connected to a host.
Status STATUS_ERROR = 3
A status representing a StreamPeerSocket in error state.
Method Descriptions
void disconnect_from_host() 🔗
Disconnects from host.
Status get_status() const 🔗
Returns the status of the connection.
Polls the socket, updating its state. See get_status().