Class ManagedNamedPipeClient

Namespace

DiscordRPC.IO

Assembly

DiscordRPC.dll

A named pipe client using the .NET framework NamedPipeClientStream

public sealed class ManagedNamedPipeClient : INamedPipeClient, IDisposable

Inheritance

object

ManagedNamedPipeClient

Implements

INamedPipeClient

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ManagedNamedPipeClient()

Creates a new instance of a Managed NamedPipe client. Doesn't connect to anything yet, just setups the values.

public ManagedNamedPipeClient()

Properties

ConnectedPipe

The pipe we are currently connected too.

public int ConnectedPipe { get; }

Property Value

int

IsConnected

Checks if the client is connected

public bool IsConnected { get; }

Property Value

bool

Logger

The logger for the Pipe client to use

public ILogger Logger { get; set; }

Property Value

ILogger

Methods

Close()

Closes the pipe

public void Close()

Connect(int)

Connects to the pipe

public bool Connect(int pipe)

Parameters

pipe int

Returns

bool

Dispose()

Disposes of the stream

public void Dispose()

GetPipeName(int)

[Obsolete("Use PipePermutation.GetPipes instead", true)]
public static string GetPipeName(int pipe)

Parameters

pipe int

Returns

string

GetPipeName(int, string)

[Obsolete("Use PipePermutation.GetPipes instead", true)]
public static string GetPipeName(int pipe, string sandbox)

Parameters

pipe int

sandbox string

Returns

string

GetPipeSandbox()

[Obsolete("Use PipePermutation.GetPipes instead", true)]
public static string GetPipeSandbox()

Returns

string

IsUnix()

[Obsolete("Use PipePermutation.GetPipes instead", true)]
public static bool IsUnix()

Returns

bool

ReadFrame(out PipeFrame)

Reads a frame, returning false if none are available

public bool ReadFrame(out PipeFrame frame)

Parameters

frame PipeFrame

Returns

bool

WriteFrame(PipeFrame)

Writes a frame to the pipe

public bool WriteFrame(PipeFrame frame)

Parameters

frame PipeFrame

Returns

bool