Queue​Client Class

Definition

Represents the queue client object.

public abstract class QueueClient : Microsoft.ServiceBus.Messaging.ClientEntity
Inheritance
QueueClient

Inherited Members

Microsoft.ServiceBus.Messaging.ClientEntity

Properties

Messaging​Factory

Gets or sets the messaging factory.

Mode

Gets the message receive mode when processing the received message.

Path

Gets or sets the full path name of the queue.

Prefetch​Count

Gets or sets the number of messages that the queue receiver can simultaneously request.

Methods

Abandon(​Guid)

Discards the message and relinquishes the message lock ownership.

Abandon(​Guid, ​IDictionary<​String,​Object>)

Discards the message and relinquishes the message lock ownership.

Abandon​Async(​Guid)

Asynchronously discards the message and relinquishes the message lock ownership.

Abandon​Async(​Guid, ​IDictionary<​String,​Object>)

Asynchronously discards the message and relinquishes the message lock ownership.

Accept​Message​Session()

Accepts a message session that allows grouping of related messages for processing in a single transaction.

Accept​Message​Session(​String)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

Accept​Message​Session(​Time​Span)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

Accept​Message​Session(​String, ​Time​Span)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

Accept​Message​Session​Async(​Time​Span)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

Accept​Message​Session​Async(​String, ​Time​Span)

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.

Accept​Message​Session​Async()

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction.

Accept​Message​Session​Async(​String)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

Cancel​Scheduled​Message​Async(​Int64)

Cancels a scheduled message

Complete(​Guid)

Completes processing of a message.

Complete​Async(​Guid)

Asynchronously completes processing of a message.

Complete​Batch(​IEnumerable<​Guid>)

Completes processing of a message batch.

Complete​Batch​Async(​IEnumerable<​Guid>)

Asynchronously completes processing of a message batch.

Create(​String)

Creates a new copy of QueueClient with specified path.

Create(​String, ​Receive​Mode)

Creates a new copy of QueueClient with specified path and mode.

Create​From​Connection​String(​String, ​String, ​Receive​Mode)

Creates a new instance of QueueClient from a connection string with the specified path and mode. Use this overload only when the connection string does not use the EntityPath property.

Create​From​Connection​String(​String)

Creates a new instance of QueueClient using the specified connection string.

Create​From​Connection​String(​String, ​Receive​Mode)

Creates a new instance of QueueClient using the specified connection string and receiving mode.

Create​From​Connection​String(​String, ​String)

Creates a new copy of QueueClient from a connection string with the specified queue path. Use this overload only when the connection string does not use the EntityPath property.

Dead​Letter(​Guid, ​String, ​String)

Moves the undelivered message to the dead letter queue.

Dead​Letter(​Guid)

Moves the undelivered message to the dead letter queue.

Dead​Letter(​Guid, ​IDictionary<​String,​Object>)

Moves the undelivered message to the dead letter queue.

Dead​Letter​Async(​Guid)

Asynchronously moves the undelivered message to the dead letter queue.

Dead​Letter​Async(​Guid, ​IDictionary<​String,​Object>)

Asynchronously moves the undelivered message to the dead letter queue.

Dead​Letter​Async(​Guid, ​String, ​String)

Asynchronously moves the undelivered message to the dead letter queue.

Defer(​Guid)

Suspends the processing of a message.

Defer(​Guid, ​IDictionary<​String,​Object>)

Suspends the processing of a message.

Defer​Async(​Guid)

Asynchronously suspends the processing of a message.

Defer​Async(​Guid, ​IDictionary<​String,​Object>)

Asynchronously suspends the processing of a message.

Format​Dead​Letter​Path(​String)

Builds a format name from the specified dead letter queue path.

Format​Transfer​Dead​Letter​Path(​String)
Get​Message​Sessions(​Date​Time)

Retrieves all message sessions whose session state was updated since lastUpdatedTime.

Get​Message​Sessions()

Gets the message sessions, enabling you to browse sessions on queues.

Get​Message​Sessions​Async()

Asynchronously gets the message sessions, enabling you to browse sessions on queues.

Get​Message​Sessions​Async(​Date​Time)

Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime.

On​Abort()

Executes upon calling the Abort event.

On​Begin​Accept​Message​Session(​String, ​Receive​Mode, ​Int32, ​Time​Span, ​Time​Span, ​Async​Callback, ​Object)
On​Begin​Close(​Time​Span, ​Async​Callback, ​Object)

Executes when the Close operation is called.

On​Begin​Create​Receiver(​String, ​Receive​Mode, ​Time​Span, ​Async​Callback, ​Object)

Executes the begin create receiver action.

On​Begin​Create​Receiver(​Receive​Mode, ​Time​Span, ​Async​Callback, ​Object)

Executes the begin create receiver action.

On​Begin​Create​Sender(​Time​Span, ​Async​Callback, ​Object)

Executes the begin create sender action.

On​Begin​Get​Message​Sessions(​Date​Time, ​Async​Callback, ​Object)

Executes the BeginGetMessageSessions action.

On​Close(​Time​Span)

Executes upon calling the Close action.

On​End​Accept​Message​Session(​IAsync​Result)

Executes upon calling the EndAcceptMessageSession operation.

On​End​Close(​IAsync​Result)

Executes the end close action.

On​End​Create​Receiver(​IAsync​Result)

Executes the end create receiver action.

On​End​Create​Sender(​IAsync​Result)

Executes the end create sender action.

On​End​Get​Message​Sessions(​IAsync​Result)

Executes the end get message action.

On​Message(​Action<​Brokered​Message>)

Processes a message in an event-driven message pump.

On​Message(​Action<​Brokered​Message>, ​On​Message​Options)

Processes a message in an event-driven message pump, with the given set of OnMessageOptions options.

On​Message​Async(​Func<​Brokered​Message,​Task>)

Asynchronously processes a message.

On​Message​Async(​Func<​Brokered​Message,​Task>, ​On​Message​Options)

Asynchronously processes a message.

Peek(​Int64)

Returns without removing the first message in the queue.

Peek()

Returns without removing the first message in the queue.

Peek​Async()

Asynchronously returns without removing the first message in the queue.

Peek​Async(​Int64)

Asynchronously returns without removing the first message in the queue.

Peek​Batch(​Int32)

Peeks a batch of messages.

Peek​Batch(​Int64, ​Int32)

Peeks a batch of messages.

Peek​Batch​Async(​Int32)

Asynchronously peeks a batch of message.

Peek​Batch​Async(​Int64, ​Int32)

Asynchronously peeks a batch of message.

Receive()

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive(​Int64)

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive(​Time​Span)

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive​Async(​Time​Span)

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive​Async()

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive​Async(​Int64)

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive​Batch(​IEnumerable<​Int64>)

Receives a message batch.

Receive​Batch(​Int32)

Receives a message batch.

Receive​Batch(​Int32, ​Time​Span)

Receives a message batch.

Receive​Batch​Async(​IEnumerable<​Int64>)

Asynchronously receives a message batch.

Receive​Batch​Async(​Int32)

Asynchronously receives a message batch.

Receive​Batch​Async(​Int32, ​Time​Span)

Asynchronously receives a message batch.

Register​Session​Handler(​Type)

Registers the session handler with specific type.

Register​Session​Handler(​Type, ​Session​Handler​Options)

Registers the session handler with specific type and handler options.

Register​Session​Handler​Async(​Type, ​Session​Handler​Options)

Asynchronously registers the session handler with specific type and handler options.

Register​Session​Handler​Async(​Type)

Asynchronously registers the session handler with specific type.

Register​Session​Handler​Factory(​IMessage​Session​Async​Handler​Factory, ​Session​Handler​Options)

Registers a message session handler factory with specified options.

Register​Session​Handler​Factory(​IMessage​Session​Handler​Factory, ​Session​Handler​Options)

Registers a message session handler factory with specified options.

Register​Session​Handler​Factory​Async(​IMessage​Session​Async​Handler​Factory, ​Session​Handler​Options)

Asynchronously registers a message session handler factory.

Register​Session​Handler​Factory​Async(​IMessage​Session​Handler​Factory, ​Session​Handler​Options)

Asynchronously registers a message session handler factory.

Renew​Message​Lock(​Guid)
Renew​Message​Lock​Async(​Guid)
Schedule​Message​Async(​Brokered​Message, ​Date​Time​Offset)

Sends a scheduled message

Send(​Brokered​Message)

Sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

Send​Async(​Brokered​Message)

Asynchronously sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

Send​Batch(​IEnumerable<​Brokered​Message>)

Sends a set of brokered messages (for batch processing).

Send​Batch​Async(​IEnumerable<​Brokered​Message>)

Asynchronously sends a set of brokered messages (for batch processing).

Extension Methods

IsDefined(Object)
IsNull(Object)
IsPrimitive(Object)