StreamPeerSocket

Abstract base class for interacting with socket streams.

1.0.0

class StreamPeerSocketReckfellSharpInherits StreamPeer

Abstract base class for interacting with socket streams.

StreamPeerSocket is an abstract base class that defines common behavior for socket-based streams.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods3

DisconnectFromHostvoid

C#
public void DisconnectFromHost();

Disconnects from host.

GetStatusStreamPeerSocket.Status

C#
public StreamPeerSocket.Status GetStatus();

Returns the status of the connection.

Returns StreamPeerSocket.Status

PollError

C#
public Error Poll();

Polls the socket, updating its state. See StreamPeerSocket.GetStatus.

Returns Error

Value	Description
`Connected = 2`	A status representing a `StreamPeerSocket` that is connected to a host.
`Connecting = 1`	A status representing a `StreamPeerSocket` that is connecting to a host.
`Error = 3`	A status representing a `StreamPeerSocket` in error state.
`None = 0`	The initial status of the `StreamPeerSocket`. This is also the status after disconnecting.

Reckfell Engine documentationBack to top ↑