Interface IBufferedMessageStream

Defines byte-oriented I/O with helpers that expose buffered data as binary messages.

public interface IBufferedMessageStream : IManualStream, IMessageStream, IMessageStreamBase, IDisposable, IAsyncDisposable

Methods

Reads available data into a buffered message, subject to a maximum size.

IBufferedBinaryMessage ReadAsMessage(int maxSize = 2048)

maxSize int

The maximum number of bytes to place in the returned message.

A buffered message owned by the caller.

Asynchronously reads available data into a buffered message, subject to a maximum size.

ValueTask<IBufferedBinaryMessage> ReadAsMessageAsync(int maxSize = 2048, CancellationToken cancellationToken = default)

maxSize int

The maximum number of bytes to place in the returned message.

cancellationToken CancellationToken

A token used to cancel the read.

A buffered message owned by the caller.

Writes the buffered bytes contained in a message.

void WriteAsMessage(IBufferedBinaryMessage message)

The message whose buffered bytes are written.

Asynchronously writes the buffered bytes contained in a message.

ValueTask WriteAsMessageAsync(IBufferedBinaryMessage message, CancellationToken cancellationToken = default)

The message whose buffered bytes are written.

cancellationToken CancellationToken

A token used to cancel the write.

A task that completes when the buffered bytes have been written.