Class TaskSchedulerSubscribableChannelWriter

Namespace

Steeltoe.Messaging.Support

Assembly

Steeltoe.Messaging.MessagingBase.dll

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public class TaskSchedulerSubscribableChannelWriter : AbstractMessageChannelWriter

Inheritance

object

ChannelWriter<IMessage>

AbstractMessageChannelWriter

TaskSchedulerSubscribableChannelWriter

Inherited Members

AbstractMessageChannelWriter.channel

AbstractMessageChannelWriter.logger

ChannelWriter<IMessage>.Complete(Exception)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TaskSchedulerSubscribableChannelWriter(TaskSchedulerSubscribableChannel, ILogger)

public TaskSchedulerSubscribableChannelWriter(TaskSchedulerSubscribableChannel channel, ILogger logger = null)

Parameters

channel TaskSchedulerSubscribableChannel

logger ILogger

Properties

Channel

public virtual TaskSchedulerSubscribableChannel Channel { get; }

Property Value

TaskSchedulerSubscribableChannel

Methods

TryComplete(Exception)

Attempts to mark the channel as being completed, meaning no more data will be written to it.

public override bool TryComplete(Exception error = null)

Parameters

error Exception

An Exception indicating the failure causing no more data to be written, or null for success.

Returns

bool

true if this operation successfully completes the channel; otherwise, false if the channel could not be marked for completion, for example due to having already been marked as such, or due to not supporting completion. .

TryWrite(IMessage)

Attempts to write the specified item to the channel.

public override bool TryWrite(IMessage message)

Parameters

message IMessage

Returns

bool

true if the item was written; otherwise, false.

WaitToWriteAsync(CancellationToken)

Returns a ValueTask<TResult> that will complete when space is available to write an item.

public override ValueTask<bool> WaitToWriteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken used to cancel the wait operation.

Returns

ValueTask<bool>

A ValueTask<TResult> that will complete with a true result when space is available to write an item or with a false result when no further writing will be permitted.

WriteAsync(IMessage, CancellationToken)

Asynchronously writes an item to the channel.

public override ValueTask WriteAsync(IMessage message, CancellationToken cancellationToken = default)

Parameters

message IMessage

cancellationToken CancellationToken

A CancellationToken used to cancel the write operation.

Returns

ValueTask

A ValueTask that represents the asynchronous write operation.