Class BlockingQueueConsumer

Namespace

Steeltoe.Messaging.RabbitMQ.Listener

Assembly

Steeltoe.Messaging.RabbitMQ.dll

public class BlockingQueueConsumer

Inheritance

object

BlockingQueueConsumer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

BlockingQueueConsumer(IConnectionFactory, IMessageHeadersConverter, ActiveObjectCounter<BlockingQueueConsumer>, AcknowledgeMode, bool, ushort, ILoggerFactory, params string[])

public BlockingQueueConsumer(IConnectionFactory connectionFactory, IMessageHeadersConverter messagePropertiesConverter, ActiveObjectCounter<BlockingQueueConsumer> activeObjectCounter, AcknowledgeMode acknowledgeMode, bool transactional, ushort prefetchCount, ILoggerFactory loggerFactory, params string[] queues)

Parameters

connectionFactory IConnectionFactory

messagePropertiesConverter IMessageHeadersConverter

activeObjectCounter ActiveObjectCounter<BlockingQueueConsumer>

acknowledgeMode AcknowledgeMode

transactional bool

prefetchCount ushort

loggerFactory ILoggerFactory

queues string[]

BlockingQueueConsumer(IConnectionFactory, IMessageHeadersConverter, ActiveObjectCounter<BlockingQueueConsumer>, AcknowledgeMode, bool, ushort, bool, ILoggerFactory, params string[])

public BlockingQueueConsumer(IConnectionFactory connectionFactory, IMessageHeadersConverter messagePropertiesConverter, ActiveObjectCounter<BlockingQueueConsumer> activeObjectCounter, AcknowledgeMode acknowledgeMode, bool transactional, ushort prefetchCount, bool defaultRequeueRejected, ILoggerFactory loggerFactory, params string[] queues)

Parameters

connectionFactory IConnectionFactory

messagePropertiesConverter IMessageHeadersConverter

activeObjectCounter ActiveObjectCounter<BlockingQueueConsumer>

acknowledgeMode AcknowledgeMode

transactional bool

prefetchCount ushort

defaultRequeueRejected bool

loggerFactory ILoggerFactory

queues string[]

BlockingQueueConsumer(IConnectionFactory, IMessageHeadersConverter, ActiveObjectCounter<BlockingQueueConsumer>, AcknowledgeMode, bool, ushort, bool, Dictionary<string, object>, ILoggerFactory, params string[])

public BlockingQueueConsumer(IConnectionFactory connectionFactory, IMessageHeadersConverter messagePropertiesConverter, ActiveObjectCounter<BlockingQueueConsumer> activeObjectCounter, AcknowledgeMode acknowledgeMode, bool transactional, ushort prefetchCount, bool defaultRequeueRejected, Dictionary<string, object> consumerArgs, ILoggerFactory loggerFactory, params string[] queues)

Parameters

connectionFactory IConnectionFactory

messagePropertiesConverter IMessageHeadersConverter

activeObjectCounter ActiveObjectCounter<BlockingQueueConsumer>

acknowledgeMode AcknowledgeMode

transactional bool

prefetchCount ushort

defaultRequeueRejected bool

consumerArgs Dictionary<string, object>

loggerFactory ILoggerFactory

queues string[]

BlockingQueueConsumer(IConnectionFactory, IMessageHeadersConverter, ActiveObjectCounter<BlockingQueueConsumer>, AcknowledgeMode, bool, ushort, bool, Dictionary<string, object>, bool, ILoggerFactory, params string[])

public BlockingQueueConsumer(IConnectionFactory connectionFactory, IMessageHeadersConverter messagePropertiesConverter, ActiveObjectCounter<BlockingQueueConsumer> activeObjectCounter, AcknowledgeMode acknowledgeMode, bool transactional, ushort prefetchCount, bool defaultRequeueRejected, Dictionary<string, object> consumerArgs, bool exclusive, ILoggerFactory loggerFactory, params string[] queues)

Parameters

connectionFactory IConnectionFactory

messagePropertiesConverter IMessageHeadersConverter

activeObjectCounter ActiveObjectCounter<BlockingQueueConsumer>

acknowledgeMode AcknowledgeMode

transactional bool

prefetchCount ushort

defaultRequeueRejected bool

consumerArgs Dictionary<string, object>

exclusive bool

loggerFactory ILoggerFactory

queues string[]

BlockingQueueConsumer(IConnectionFactory, IMessageHeadersConverter, ActiveObjectCounter<BlockingQueueConsumer>, AcknowledgeMode, bool, ushort, bool, Dictionary<string, object>, bool, bool, ILoggerFactory, params string[])

public BlockingQueueConsumer(IConnectionFactory connectionFactory, IMessageHeadersConverter messagePropertiesConverter, ActiveObjectCounter<BlockingQueueConsumer> activeObjectCounter, AcknowledgeMode acknowledgeMode, bool transactional, ushort prefetchCount, bool defaultRequeueRejected, Dictionary<string, object> consumerArgs, bool noLocal, bool exclusive, ILoggerFactory loggerFactory, params string[] queues)

Parameters

connectionFactory IConnectionFactory

messagePropertiesConverter IMessageHeadersConverter

activeObjectCounter ActiveObjectCounter<BlockingQueueConsumer>

acknowledgeMode AcknowledgeMode

transactional bool

prefetchCount ushort

defaultRequeueRejected bool

consumerArgs Dictionary<string, object>

noLocal bool

exclusive bool

loggerFactory ILoggerFactory

queues string[]

Properties

AbortStarted

public long AbortStarted { get; }

Property Value

long

AcknowledgeMode

public AcknowledgeMode AcknowledgeMode { get; }

Property Value

AcknowledgeMode

ActiveObjectCounter

public ActiveObjectCounter<BlockingQueueConsumer> ActiveObjectCounter { get; }

Property Value

ActiveObjectCounter<BlockingQueueConsumer>

BackOffExecution

public IBackOffExecution BackOffExecution { get; set; }

Property Value

IBackOffExecution

Cancel

public AtomicBoolean Cancel { get; }

Property Value

AtomicBoolean

Cancelled

protected bool Cancelled { get; }

Property Value

bool

Channel

public IModel Channel { get; }

Property Value

IModel

ConnectionFactory

public IConnectionFactory ConnectionFactory { get; }

Property Value

IConnectionFactory

ConsumerArgs

public Dictionary<string, object> ConsumerArgs { get; }

Property Value

Dictionary<string, object>

DeclarationRetries

public int DeclarationRetries { get; set; }

Property Value

int

Declaring

public bool Declaring { get; set; }

Property Value

bool

DefaultRequeueRejected

public bool DefaultRequeueRejected { get; }

Property Value

bool

DeliveryTags

public HashSet<ulong> DeliveryTags { get; }

Property Value

HashSet<ulong>

Exclusive

public bool Exclusive { get; }

Property Value

bool

FailedDeclarationRetryInterval

public int FailedDeclarationRetryInterval { get; set; }

Property Value

int

HasDelivery

protected bool HasDelivery { get; }

Property Value

bool

LastRetryDeclaration

public long LastRetryDeclaration { get; set; }

Property Value

long

LocallyTransacted

public bool LocallyTransacted { get; set; }

Property Value

bool

Logger

public ILogger<BlockingQueueConsumer> Logger { get; }

Property Value

ILogger<BlockingQueueConsumer>

LoggerFactory

public ILoggerFactory LoggerFactory { get; }

Property Value

ILoggerFactory

MessageHeadersConverter

public IMessageHeadersConverter MessageHeadersConverter { get; set; }

Property Value

IMessageHeadersConverter

MissingQueues

public HashSet<string> MissingQueues { get; }

Property Value

HashSet<string>

NoLocal

public bool NoLocal { get; }

Property Value

bool

NormalCancel

public bool NormalCancel { get; set; }

Property Value

bool

PrefetchCount

public ushort PrefetchCount { get; }

Property Value

ushort

Queue

public BlockingCollection<Delivery> Queue { get; }

Property Value

BlockingCollection<Delivery>

QueueCount

public int QueueCount { get; }

Property Value

int

Queues

public List<string> Queues { get; }

Property Value

List<string>

ResourceHolder

public RabbitResourceHolder ResourceHolder { get; set; }

Property Value

RabbitResourceHolder

RetryDeclarationInterval

public int RetryDeclarationInterval { get; set; }

Property Value

int

Shutdown

public ShutdownEventArgs Shutdown { get; }

Property Value

ShutdownEventArgs

ShutdownTimeout

public int ShutdownTimeout { get; set; }

Property Value

int

TagStrategy

public IConsumerTagStrategy TagStrategy { get; set; }

Property Value

IConsumerTagStrategy

Transactional

public bool Transactional { get; }

Property Value

bool

Methods

BasicCancel()

protected void BasicCancel()

BasicCancel(bool)

protected void BasicCancel(bool expected)

Parameters

expected bool

ClearDeliveryTags()

public void ClearDeliveryTags()

CommitIfNecessary(bool)

public bool CommitIfNecessary(bool localTx)

Parameters

localTx bool

Returns

bool

GetConsumerTags()

public List<string> GetConsumerTags()

Returns

List<string>

NextMessage()

public IMessage NextMessage()

Returns

IMessage

NextMessage(int)

public IMessage NextMessage(int timeout)

Parameters

timeout int

Returns

IMessage

RollbackOnExceptionIfNecessary(Exception)

public void RollbackOnExceptionIfNecessary(Exception ex)

Parameters

ex Exception

Start()

public void Start()

Stop()

public void Stop()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.