SALES: 1-800-867-1380
Expand Minimize

QueueClient Methods

The QueueClient type exposes the following members.

  Name Description
Public method Abandon(Guid) Discards the message and relinquishes the message lock ownership.
Public method Abandon(Guid, IDictionary<String, Object>) Discards the message and relinquishes the message lock ownership.
Public method AbandonAsync(Guid) Asynchronously discards the message and relinquishes the message lock ownership.
Public method AbandonAsync(Guid, IDictionary<String, Object>) Asynchronously discards the message and relinquishes the message lock ownership.
Public method Abort Performs abort functionality on the messaging entity. (Inherited from ClientEntity.)
Public method AcceptMessageSession() Accepts a message session that allows grouping of related messages for processing in a single transaction.
Public method AcceptMessageSession(String) Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.
Public method AcceptMessageSession(TimeSpan) Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.
Public method AcceptMessageSession(String, TimeSpan) Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.
Public method AcceptMessageSessionAsync() Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction.
Public method AcceptMessageSessionAsync(String) Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.
Public method AcceptMessageSessionAsync(TimeSpan) Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.
Public method AcceptMessageSessionAsync(String, TimeSpan) Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.
Public method BeginAbandon(Guid, AsyncCallback, Object) Begins an asynchronous operation to abandon the message and relinquish its lock.
Public method BeginAbandon(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to abandon the message and relinquish its lock.
Public method BeginAcceptMessageSession(AsyncCallback, Object) Begins an asynchronous operation to accept a message session.
Public method BeginAcceptMessageSession(String, AsyncCallback, Object) Begins an asynchronous operation to accept a message session.
Public method BeginAcceptMessageSession(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to accept a message session.
Public method BeginAcceptMessageSession(String, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to accept a message session.
Public method BeginClose Begins an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method BeginComplete Begins an asynchronous operation to complete processing of a message.
Public method BeginCompleteBatch Begins an asynchronous operation to complete processing of a message batch.
Public method BeginDeadLetter(Guid, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDeadLetter(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDeadLetter(Guid, String, String, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDefer(Guid, AsyncCallback, Object) Begins an asynchronous operation to suspend processing of a message.
Public method BeginDefer(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to suspend processing of a message.
Public method BeginGetMessageSessions(AsyncCallback, Object) Begins an asynchronous operation to get the message sessions.
Public method BeginGetMessageSessions(DateTime, AsyncCallback, Object) Begins an asynchronous operation to get the message sessions.
Public method BeginPeek(AsyncCallback, Object) Begins an asynchronous operation to peek a message.
Public method BeginPeek(Int64, AsyncCallback, Object) Begins an asynchronous operation to peek a message.
Public method BeginPeekBatch(Int32, AsyncCallback, Object) Begins an asynchronous operation to peek a batch of messages.
Public method BeginPeekBatch(Int64, Int32, AsyncCallback, Object) Begins an asynchronous operation to peek a batch of messages.
Public method BeginReceive(AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceive(Int64, AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceive(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceiveBatch(IEnumerable<Int64>, AsyncCallback, Object) Begins an asynchronous operation to receive a message batch.
Public method BeginReceiveBatch(Int32, AsyncCallback, Object) Begins an asynchronous operation to receive a message batch.
Public method BeginReceiveBatch(Int32, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a message batch.
Public method BeginSend Begins an asynchronous operation to send a message.
Public method BeginSendBatch Begins an asynchronous operation to send a message batch.
Public method Close Sends a cleanup message to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public method CloseAsync Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public method Complete Completes processing of a message.
Public method CompleteAsync Asynchronously completes processing of a message.
Public method CompleteBatch Completes processing of a message batch.
Public method CompleteBatchAsync Asynchronously completes processing of a message batch.
Public method Static member Create(String) Creates a new copy of QueueClient with specified path.
Public method Static member Create(String, ReceiveMode) Creates a new copy of QueueClient with specified path and mode.
Public method Static member CreateFromConnectionString(String, String) Creates a new copy of QueueClient from connection string with specified path.
Public method Static member CreateFromConnectionString(String, String, ReceiveMode) Creates a new copy of QueueClient from connection string with specified path and mode.
Public method DeadLetter(Guid) Moves the undelivered message to the dead letter queue.
Public method DeadLetter(Guid, IDictionary<String, Object>) Moves the undelivered message to the dead letter queue.
Public method DeadLetter(Guid, String, String) Moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid) Asynchronously moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid, IDictionary<String, Object>) Asynchronously moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid, String, String) Asynchronously moves the undelivered message to the dead letter queue.
Public method Defer(Guid) Suspends the processing of a message.
Public method Defer(Guid, IDictionary<String, Object>) Suspends the processing of a message.
Public method DeferAsync(Guid) Asynchronously suspends the processing of a message.
Public method DeferAsync(Guid, IDictionary<String, Object>) Asynchronously suspends the processing of a message.
Public method EndAbandon Finishes an asynchronous operation to abandon the message and relinquish its lock.
Public method EndAcceptMessageSession Finishes an asynchronous operation to accept a message session that allows grouping of related messages for processing in a single transaction.
Public method EndClose Finishes an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method EndComplete Finishes an asynchronous operation to complete processing of a message.
Public method EndCompleteBatch Finishes an asynchronous operation to complete processing of a message batch.
Public method EndDeadLetter Finishes an asynchronous operation to move message to the dead letter queue.
Public method EndDefer Finishes an asynchronous operation to suspend processing of a message.
Public method EndGetMessageSessions Ends an asynchronous operation to get the message sessions.
Public method EndPeek Ends an asynchronous operation to peek a message.
Public method EndPeekBatch Ends an asynchronous operation to peek a batch of messages.
Public method EndReceive Finishes an asynchronous operation to receive a message.
Public method EndReceiveBatch Finishes an asynchronous operation to receive a message batch.
Public method EndSend Finishes an asynchronous operation to send a message.
Public method EndSendBatch Finishes an asynchronous operation to send a message batch.
Public method Equals (Inherited from Object.)
Protected method Fault For internal use only. Do not inherit from this class. (Inherited from ClientEntity.)
Protected method Finalize (Inherited from Object.)
Public method Static member FormatDeadLetterPath Builds a format name from the specified dead letter queue path.
Public method GetHashCode (Inherited from Object.)
Public method GetMessageSessions() Gets the message sessions, enabling you to browse sessions on queues.
Public method GetMessageSessions(DateTime) Retrieves all message sessions whose session state was updated since lastUpdatedTime.
Public method GetMessageSessionsAsync() Asynchronously gets the message sessions, enabling you to browse sessions on queues.
Public method GetMessageSessionsAsync(DateTime) Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAbort Executes upon calling the Abort event. (Overrides ClientEntity.OnAbort().)
Protected method OnBeginAcceptMessageSession Executes upon calling the BeginAcceptMessageSession operation.
Protected method OnBeginClose Executes when the Close operation is called. (Overrides ClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) Executes the begin create receiver action.
Protected method OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object) Executes the begin create receiver action.
Protected method OnBeginCreateSender Executes the begin create sender action.
Protected method OnBeginGetMessageSessions Executes the BeginGetMessageSessions action.
Protected method OnBeginOpen (Inherited from ClientEntity.)
Protected method OnClose Executes upon calling the Close action. (Overrides ClientEntity.OnClose(TimeSpan).)
Protected method OnClosed (Inherited from ClientEntity.)
Protected method OnEndAcceptMessageSession Executes upon calling the EndAcceptMessageSession operation.
Protected method OnEndClose Executes the end close action. (Overrides ClientEntity.OnEndClose(IAsyncResult).)
Protected method OnEndCreateReceiver Executes the end create receiver action.
Protected method OnEndCreateSender Executes the end create sender action.
Protected method OnEndGetMessageSessions Executes the end get message action.
Protected method OnEndOpen (Inherited from ClientEntity.)
Protected method OnFaulted (Inherited from ClientEntity.)
Public method OnMessage(Action<BrokeredMessage>) Processes a message in an event-driven message pump.
Public method OnMessage(Action<BrokeredMessage>, OnMessageOptions) Processes a message in an event-driven message pump, with the given set of OnMessageOptions options.
Public method OnMessageAsync(Func<BrokeredMessage, Task>) Asynchronously processes a message.
Public method OnMessageAsync(Func<BrokeredMessage, Task>, OnMessageOptions) Asynchronously processes a message.
Protected method OnOpen (Inherited from ClientEntity.)
Protected method OnOpened (Inherited from ClientEntity.)
Public method Peek() Returns without removing the first message in the queue.
Public method Peek(Int64) Returns without removing the first message in the queue.
Public method PeekAsync() Asynchronously returns without removing the first message in the queue.
Public method PeekAsync(Int64) Asynchronously returns without removing the first message in the queue.
Public method PeekBatch(Int32) Peeks a batch of message.
Public method PeekBatch(Int64, Int32) Peeks a batch of messages.
Public method PeekBatchAsync(Int32) Asynchronously peeks a batch of message.
Public method PeekBatchAsync(Int64, Int32) Asynchronously peeks a batch of message.
Public method Receive() Receives a message using the InternalReceiver().
Public method Receive(Int64) Receives a message using the InternalReceiver().
Public method Receive(TimeSpan) Receives a message using the InternalReceiver().
Public method ReceiveAsync() Asynchronously receives a message using the InternalReceiver().
Public method ReceiveAsync(Int64) Asynchronously receives a message using the InternalReceiver().
Public method ReceiveAsync(TimeSpan) Asynchronously receives a message using the InternalReceiver().
Public method ReceiveBatch(IEnumerable<Int64>) Receives a message batch.
Public method ReceiveBatch(Int32) Receives a message batch.
Public method ReceiveBatch(Int32, TimeSpan) Receives a message batch.
Public method ReceiveBatchAsync(IEnumerable<Int64>) Asynchronously receives a message batch.
Public method ReceiveBatchAsync(Int32) Asynchronously receives a message batch.
Public method ReceiveBatchAsync(Int32, TimeSpan) Asynchronously receives a message batch.
Public method RegisterSessionHandler(Type) Registers the session handler with specific type.
Public method RegisterSessionHandler(Type, SessionHandlerOptions) Registers the session handler with specific type and handler options.
Public method RegisterSessionHandlerAsync(Type) Asynchronously registers the session handler with specific type.
Public method RegisterSessionHandlerAsync(Type, SessionHandlerOptions) Asynchronously registers the session handler with specific type and handler options.
Public method RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) Registers a message session handler factory with specified options.
Public method RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions) Registers a message session handler factory with specified options.
Public method RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) Asynchronously registers a message session handler factory.
Public method RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions) Asynchronously registers a message session handler factory.
Public method Send Sends a message using the InternalSender().
Public method SendAsync Asynchronously sends a message using the InternalSender().
Public method SendBatch Sends a set of brokered messages (for batch processing).
Public method SendBatchAsync Asynchronously sends a set of brokered messages (for batch processing).
Protected method ThrowIfClosed (Inherited from ClientEntity.)
Protected method ThrowIfDisposed (Inherited from ClientEntity.)
Protected method ThrowIfDisposedOrImmutable (Inherited from ClientEntity.)
Protected method ThrowIfDisposedOrNotOpen (Inherited from ClientEntity.)
Protected method ThrowIfFaulted (Inherited from ClientEntity.)
Public method ToString (Inherited from Object.)
Top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft