Class PersistentChannel<TInput, TOutput>

Represents persistent unbounded channel.

Inheritance

Object

PersistentChannel<TInput, TOutput>

Implements

IDisposable

Namespace: DotNext.Threading.Channels

Assembly: DotNext.Threading.dll

Syntax

public abstract class PersistentChannel<TInput, TOutput> : Channel<TInput, TOutput>, IChannelWriter<TInput>, IChannelReader<TOutput>, IChannel, IDisposable

Type Parameters

Name	Description
TInput	Specifies the type of data that may be written to the channel.
TOutput	Specifies the type of data that may be read from the channel.

Constructors

| Improve this Doc View Source

PersistentChannel(PersistentChannelOptions)

Initializes a new persistent channel with the specified options.

Declaration

protected PersistentChannel(PersistentChannelOptions options)

Parameters

Type	Name	Description
PersistentChannelOptions	options	The options of the channel.

Properties

| Improve this Doc View Source

Throughput

Gets ratio between number of consumed and produced messages.

Declaration

public double Throughput { get; }

Property Value

Type	Description
Double

Methods

| Improve this Doc View Source

DeserializeAsync(Stream, CancellationToken)

Deserializes message from stream asynchronously.

Declaration

protected abstract ValueTask<TOutput> DeserializeAsync(Stream input, CancellationToken token)

Parameters

Type	Name	Description
Stream	input	The stream containing serialized message.
CancellationToken	token	The token that can be used to cancel the operation.

Returns

Type	Description
ValueTask<TOutput>	Deserialized message.

| Improve this Doc View Source

Dispose()

Releases all resources associated with this channel.

Declaration

public void Dispose()

| Improve this Doc View Source

Dispose(Boolean)

Releases managed and, optionally, unmanaged resources associated with this channel.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	true to dispose all resources; false to release unmanaged resources only.

| Improve this Doc View Source

Finalize()

Releases file handles associated with this channel.

Declaration

protected void Finalize()

| Improve this Doc View Source

SerializeAsync(TInput, Stream, CancellationToken)

Serializes message to stream asynchronously.

Declaration

protected abstract ValueTask SerializeAsync(TInput input, Stream output, CancellationToken token)

Parameters

Type	Name	Description
TInput	input	The message to serialize.
Stream	output	The stream used to serialize object.
CancellationToken	token	The token that can be used to cancel the operation.