C# Class paramore.brighter.commandprocessor.messaginggateway.rmq.RmqMessageConsumer

Class RmqMessageConsumer. The RmqMessageConsumer is used on the server to receive messages from the broker. It abstracts away the details of inter-process communication tasks from the server. It handles connection establishment, request reception and dispatching, result sending, and error handling.
Inheritance: MessageGateway, IAmAMessageConsumerSupportingDelay
Mostra file Open project: iancooper/Paramore

Private Properties

Property Type Description
CancelConsumer void
EnsureChannelBind void
EnsureConsumer void
SetConsumerArguments object>.Dictionary
SetQueueArguments object>.Dictionary

Public Methods

Method Description
Acknowledge ( Message message ) : void

Acknowledges the specified message.

Dispose ( ) : void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Purge ( ) : void

Purges the specified queue name.

Receive ( int timeoutInMilliseconds ) : Message

Receives the specified queue name.

Reject ( Message message, bool requeue ) : void

Rejects the specified message.

Requeue ( Message message ) : void
Requeue ( Message message, int delayMilliseconds ) : void
RmqMessageConsumer ( RmqMessagingGatewayConnection connection, string queueName, string routingKey, bool isDurable, ushort preFetchSize = 1, bool highAvailability = false ) : System

Initializes a new instance of the MessageGateway class.

Protected Methods

Method Description
CreateConsumer ( ) : void

Private Methods

Method Description
CancelConsumer ( ) : void
EnsureChannelBind ( ) : void
EnsureConsumer ( ) : void
SetConsumerArguments ( ) : object>.Dictionary
SetQueueArguments ( ) : object>.Dictionary

Method Details

Acknowledge() public method

Acknowledges the specified message.
public Acknowledge ( Message message ) : void
message Message The message.
return void

CreateConsumer() protected method

protected CreateConsumer ( ) : void
return void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public Dispose ( ) : void
return void

Purge() public method

Purges the specified queue name.
public Purge ( ) : void
return void

Receive() public method

Receives the specified queue name.
public Receive ( int timeoutInMilliseconds ) : Message
timeoutInMilliseconds int The timeout in milliseconds.
return Message

Reject() public method

Rejects the specified message.
public Reject ( Message message, bool requeue ) : void
message Message The message.
requeue bool if set to true [requeue].
return void

Requeue() public method

public Requeue ( Message message ) : void
message Message
return void

Requeue() public method

public Requeue ( Message message, int delayMilliseconds ) : void
message Message
delayMilliseconds int
return void

RmqMessageConsumer() public method

Initializes a new instance of the MessageGateway class.
public RmqMessageConsumer ( RmqMessagingGatewayConnection connection, string queueName, string routingKey, bool isDurable, ushort preFetchSize = 1, bool highAvailability = false ) : System
connection paramore.brighter.commandprocessor.messaginggateway.rmq.MessagingGatewayConfiguration.RmqMessagingGatewayConnection
queueName string The queue name.
routingKey string The routing key.
isDurable bool Is the queue persisted to disk
preFetchSize ushort 0="Don't send me a new message until I?ve finished", 1= "Send me one message at a time", n = number to grab (take care with competing consumers)
highAvailability bool
return System