Table of Contents

Class QueueChannel

Namespace
Steeltoe.Integration.Channel
Assembly
Steeltoe.Integration.IntegrationBase.dll
public class QueueChannel : AbstractPollableChannel, IPollableChannel, IMessageChannel, IServiceNameAware, ITaskSchedulerChannelInterceptorAware, IChannelInterceptorAware, IQueueChannelOperations
Inheritance
QueueChannel
Implements
Inherited Members

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