C# Class System.Reactive.IronMQ.Queue

All creation methods ensure that a queue with Name exist on the server-side. However, the queue can be deleted using DeleteAsync at any time, so we cannot maintain the invariant that a Queue instance on the client always corresponds to a queue instance on the server.

显示文件 Open project: Applied-Duality/IronMQ

Public Methods

Method	Description
AddMessageAsync ( string body, long timeout = 60, long delay, long expires = 604800 ) : Task	Add single message to a queue, and if succeeded return message with updated ID.
AddMessagesAsync ( ) : Task	Add messages to a queue, and return messages added to the queue with updated ID.
AddSubscribersAsync ( ) : Task	Add subscribers to queue.
ClearMessagesAsync ( ) : Task	Clear all messages in a queue.
DeleteAsync ( ) : Task	Delete the queue and all its messages.
DeleteMessageAsync ( Message message ) : Task	Delete message from the queue. Be sure you call this after you’re done with a message otherwise it will be placed back on the queue.
GetCountAsync ( ) : Task	Get number of messages in queue.
GetExistsAsync ( ) : Task	Check if queue exists.
GetMessageAsync ( long timeout = 60 ) : Task	Get at most 1 messages from the queue.
GetMessagesAsync ( int n = 1, long timeout = 60 ) : Task	Get at most n messages from the queue.
GetPushStatusAsync ( Message message ) : Task	Status of push notifications.
PeekMessagesAsync ( int n = 1 ) : Task	Peek at first n messages in the queue.
ReleaseMessageAsync ( Message message, long delay = 60 ) : Task	Put message back on the queue.
RemoveSubscribersAsync ( ) : Task	Remove subscribers from a queue.
TouchMessageAsync ( Message message, long delay = 60 ) : Task	Touching a reserved message extends its timeout by the duration specified when the message was created, which is 60 seconds by default.
UpdateAsync ( PushType pushtype = PushType.Multicast, int retries = 3, int retriesDelay = 60 ) : Task	Update queue.

Private Methods

Method	Description
Queue ( HttpClient client, string name ) : System.Collections.Generic

Method Details

AddMessageAsync() public method

Add single message to a queue, and if succeeded return message with updated ID.

public AddMessageAsync ( string body, long timeout = 60, long delay, long expires = 604800 ) : Task
body	string
timeout	long
delay	long
expires	long
return	Task

AddMessagesAsync() public method

Add messages to a queue, and return messages added to the queue with updated ID.

public AddMessagesAsync ( ) : Task
return	Task

AddSubscribersAsync() public method

Add subscribers to queue.

public AddSubscribersAsync ( ) : Task
return	Task

ClearMessagesAsync() public method

Clear all messages in a queue.

public ClearMessagesAsync ( ) : Task
return	Task

DeleteAsync() public method

Delete the queue and all its messages.

public DeleteAsync ( ) : Task
return	Task

DeleteMessageAsync() public method

Delete message from the queue. Be sure you call this after you’re done with a message otherwise it will be placed back on the queue.

public DeleteMessageAsync ( Message message ) : Task
message	Message
return	Task

GetCountAsync() public method

Get number of messages in queue.

public GetCountAsync ( ) : Task
return	Task

GetExistsAsync() public method

Check if queue exists.

public GetExistsAsync ( ) : Task
return	Task

GetMessageAsync() public method

Get at most 1 messages from the queue.

public GetMessageAsync ( long timeout = 60 ) : Task
timeout	long
return	Task

GetMessagesAsync() public method

Get at most n messages from the queue.

public GetMessagesAsync ( int n = 1, long timeout = 60 ) : Task
n	int
timeout	long
return	Task

GetPushStatusAsync() public method

Status of push notifications.

public GetPushStatusAsync ( Message message ) : Task
message	Message
return	Task

PeekMessagesAsync() public method

Peek at first n messages in the queue.

public PeekMessagesAsync ( int n = 1 ) : Task
n	int
return	Task

ReleaseMessageAsync() public method

Put message back on the queue.

public ReleaseMessageAsync ( Message message, long delay = 60 ) : Task
message	Message
delay	long
return	Task

RemoveSubscribersAsync() public method

Remove subscribers from a queue.

public RemoveSubscribersAsync ( ) : Task
return	Task

TouchMessageAsync() public method

Touching a reserved message extends its timeout by the duration specified when the message was created, which is 60 seconds by default.

public TouchMessageAsync ( Message message, long delay = 60 ) : Task
message	Message
delay	long
return	Task

UpdateAsync() public method

Update queue.

public UpdateAsync ( PushType pushtype = PushType.Multicast, int retries = 3, int retriesDelay = 60 ) : Task
pushtype	PushType
retries	int
retriesDelay	int
return	Task