Class IpcServer

Namespace

Nerdbank.JsonRpc

Assembly

Nerdbank.JsonRpc.dll

A same-account IPC listener with explicitly observed connection callbacks.

public sealed class IpcServer : IDisposable, IAsyncDisposable

Inheritance

object

IpcServer

Implements

IDisposable

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Completion

Gets a task that completes when listening and all accepted callbacks finish.

public Task Completion { get; }

Property Value

Task

Name

Gets the endpoint name to pass to ConnectAsync(string, CancellationToken).

public string Name { get; }

Property Value

string

Methods

Create(Func<Stream, CancellationToken, Task>, IpcServerOptions)

Starts listening before returning the endpoint.

public static IpcServer Create(Func<Stream, CancellationToken, Task> onConnected, IpcServerOptions options = default)

Parameters

onConnected Func<Stream, CancellationToken, Task>

A callback that owns the stream until it completes. The stream is then disposed.

options IpcServerOptions

Listening options.

Returns

IpcServer

The listening server.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.