PipeMessageHandler Class

Definition

An abstract base class for for sending and receiving messages using PipeReader and PipeWriter.

public abstract class PipeMessageHandler : StreamJsonRpc.MessageHandlerBase
public abstract class PipeMessageHandler : StreamJsonRpc.MessageHandlerBase, StreamJsonRpc.Reflection.IJsonRpcMessageBufferManager
type PipeMessageHandler = class
    inherit MessageHandlerBase
type PipeMessageHandler = class
    inherit MessageHandlerBase
    interface IJsonRpcMessageBufferManager
Public MustInherit Class PipeMessageHandler
Inherits MessageHandlerBase
Public MustInherit Class PipeMessageHandler
Inherits MessageHandlerBase
Implements IJsonRpcMessageBufferManager
Inheritance
PipeMessageHandler
Derived
Implements

Constructors

PipeMessageHandler(IDuplexPipe, IJsonRpcMessageFormatter)

Initializes a new instance of the PipeMessageHandler class.

PipeMessageHandler(PipeWriter, PipeReader, IJsonRpcMessageFormatter)

Initializes a new instance of the PipeMessageHandler class.

PipeMessageHandler(Stream, Stream, IJsonRpcMessageFormatter)

Initializes a new instance of the PipeMessageHandler class.

Properties

CanRead

Gets a value indicating whether this message handler can receive messages.

CanWrite

Gets a value indicating whether this message handler can send messages.

DisposalToken

Gets a token that is canceled when this instance is disposed.

(Inherited from MessageHandlerBase)
Formatter

Gets the formatter used for message serialization.

(Inherited from MessageHandlerBase)
Reader

Gets the reader to use for receiving messages.

Writer

Gets the writer to use for transmitting messages.

Methods

Dispose()
Obsolete.

Disposes this instance, and cancels any pending read or write operations.

(Inherited from MessageHandlerBase)
Dispose(Boolean)

Disposes resources allocated by this instance that are common to both reading and writing.

Dispose(Boolean)

Disposes resources allocated by this instance that are common to both reading and writing.

(Inherited from MessageHandlerBase)
DisposeAsync()

Disposes this instance, and cancels any pending read or write operations.

(Inherited from MessageHandlerBase)
DisposeReader()

Disposes resources allocated by this instance that are used for reading (not writing).

DisposeReader()

Disposes resources allocated by this instance that are used for reading (not writing).

(Inherited from MessageHandlerBase)
DisposeWriter()

Disposes resources allocated by this instance that are used for writing (not reading).

DisposeWriter()

Disposes resources allocated by this instance that are used for writing (not reading).

(Inherited from MessageHandlerBase)
FlushAsync(CancellationToken)

Ensures that all messages transmitted up to this point are en route to their destination, rather than sitting in some local buffer.

ReadAsync(CancellationToken)

Reads a distinct and complete message from the transport, waiting for one if necessary.

(Inherited from MessageHandlerBase)
ReadAtLeastAsync(Int32, Boolean, CancellationToken)

Reads from the Reader until at least a specified number of bytes are available.

ReadCoreAsync(CancellationToken)

Reads a distinct and complete message, waiting for one if necessary.

(Inherited from MessageHandlerBase)
Write(JsonRpcMessage, CancellationToken)

Writes a message to the pipe.

WriteAsync(JsonRpcMessage, CancellationToken)

Writes a message to the transport and flushes.

(Inherited from MessageHandlerBase)
WriteCoreAsync(JsonRpcMessage, CancellationToken)

Writes a message.

Explicit Interface Implementations

IDisposableObservable.IsDisposed

Gets a value indicating whether this instance has been disposed.

(Inherited from MessageHandlerBase)
IJsonRpcMessageBufferManager.DeserializationComplete(JsonRpcMessage)

Notifies that it is safe to free buffers held to deserialize the payload for a message because all deserialization attempts are completed.

Applies to