Class QueueChannel

Namespace

Steeltoe.Integration.Channel

Assembly

Steeltoe.Integration.IntegrationBase.dll

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public class QueueChannel : AbstractPollableChannel, IPollableChannel, IMessageChannel, IServiceNameAware, ITaskSchedulerChannelInterceptorAware, IChannelInterceptorAware, IQueueChannelOperations

Inheritance

object

Channel<IMessage, IMessage>

Channel<IMessage>

AbstractMessageChannel

AbstractPollableChannel

QueueChannel

Implements

IPollableChannel

IMessageChannel

IServiceNameAware

ITaskSchedulerChannelInterceptorAware

IChannelInterceptorAware

IQueueChannelOperations

Inherited Members

AbstractPollableChannel.TaskSchedulerInterceptorsSize

AbstractPollableChannel.ReceiveAsync(CancellationToken)

AbstractPollableChannel.Receive()

AbstractPollableChannel.Receive(int)

AbstractPollableChannel.DoReceive(int)

AbstractPollableChannel.DoReceive(CancellationToken)

AbstractPollableChannel.ChannelInterceptors

AbstractPollableChannel.AddInterceptor(IChannelInterceptor)

AbstractPollableChannel.AddInterceptor(int, IChannelInterceptor)

AbstractPollableChannel.RemoveInterceptor(IChannelInterceptor)

AbstractPollableChannel.RemoveInterceptor(int)

AbstractPollableChannel.HasTaskSchedulerInterceptors

AbstractMessageChannel.INDEFINITE_TIMEOUT

AbstractMessageChannel.ApplicationContext

AbstractMessageChannel.IntegrationServices

AbstractMessageChannel.ComponentType

AbstractMessageChannel.ServiceName

AbstractMessageChannel.ComponentName

AbstractMessageChannel.DataTypes

AbstractMessageChannel.MessageConverter

AbstractMessageChannel.Send(IMessage)

AbstractMessageChannel.Send(IMessage, int)

AbstractMessageChannel.SendAsync(IMessage, CancellationToken)

AbstractMessageChannel.logger

AbstractMessageChannel.DoSend(IMessage, int)

AbstractMessageChannel.DoSend(IMessage, CancellationToken)

Channel<IMessage, IMessage>.Reader

Channel<IMessage, IMessage>.Writer

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

QueueChannel(ILogger)

public QueueChannel(ILogger logger = null)

Parameters

logger ILogger

QueueChannel(IApplicationContext, ILogger)

public QueueChannel(IApplicationContext context, ILogger logger = null)

Parameters

context IApplicationContext

logger ILogger

QueueChannel(IApplicationContext, int, ILogger)

public QueueChannel(IApplicationContext context, int capacity, ILogger logger = null)

Parameters

context IApplicationContext

capacity int

logger ILogger

QueueChannel(IApplicationContext, string, ILogger)

public QueueChannel(IApplicationContext context, string name, ILogger logger = null)

Parameters

context IApplicationContext

name string

logger ILogger

QueueChannel(IApplicationContext, Channel<IMessage>, ILogger)

public QueueChannel(IApplicationContext context, Channel<IMessage> channel, ILogger logger = null)

Parameters

context IApplicationContext

channel Channel<IMessage>

logger ILogger

QueueChannel(IApplicationContext, Channel<IMessage>, string, ILogger)

public QueueChannel(IApplicationContext context, Channel<IMessage> channel, string name, ILogger logger = null)

Parameters

context IApplicationContext

channel Channel<IMessage>

name string

logger ILogger

Properties

QueueSize

Gets the size of the queue

public int QueueSize { get; }

Property Value

int

RemainingCapacity

Gets the remaining capacity of the queue

public int RemainingCapacity { get; }

Property Value

int

Methods

Clear()

Clear all items off the quewue

public IList<IMessage> Clear()

Returns

IList<IMessage>

list of removed messages

DoReceiveInternal(CancellationToken)

protected override IMessage DoReceiveInternal(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

IMessage

DoSendInternal(IMessage, CancellationToken)

protected override bool DoSendInternal(IMessage message, CancellationToken cancellationToken)

Parameters

message IMessage

cancellationToken CancellationToken

Returns

bool

Purge(IMessageSelector)

Remove any Messages that are not accepted by the provided selector.

public IList<IMessage> Purge(IMessageSelector messageSelector)

Parameters

messageSelector IMessageSelector

the selector to apply

Returns

IList<IMessage>

list of purged messages