StreamPeerUds

A stream peer that handles UNIX Domain Socket (UDS) connections.

1.0.0

class StreamPeerUdsReckfellSharpInherits StreamPeerSocket

A stream peer that handles UNIX Domain Socket (UDS) connections.

A stream peer that handles UNIX Domain Socket (UDS) connections. This object can be used to connect to UDS servers, or also is returned by a UDS server. Unix Domain Sockets provide inter-process communication on the same machine using the filesystem namespace. Note: UNIX Domain Sockets are only available on UNIX-like systems (Linux, macOS, etc.) and are not supported on Windows.

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

Constructors1

StreamPeerUdsConstructor

# StreamPeerUds

C#
public StreamPeerUds();

Methods3

BindError

# Bind

C#
public Error Bind(string path);

Opens the UDS socket, and binds it to the specified socket path. This method is generally not needed, and only used to force the subsequent call to StreamPeerUds.ConnectToHost to use the specified path as the source address.

Parameters
Name	Type	Default
`path`	`string`	—

Returns Error

ConnectToHostError

# ConnectToHost

C#
public Error ConnectToHost(string path);

Connects to the specified UNIX Domain Socket path. Returns OK on success.

Parameters
Name	Type	Default
`path`	`string`	—

Returns Error

GetConnectedPathstring

# GetConnectedPath

C#
public string GetConnectedPath();

Returns the socket path of this peer.

Returns string

Reckfell Engine documentationBack to top ↑