Subscription​Client Class

Definition

Represents the anchor class used in run-time operations related to a topic subscription.

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

Inherited Members

Microsoft.ServiceBus.Messaging.ClientEntity

Properties

Messaging​Factory

Gets the messaging factory used to create this subscription client.

Mode

Gets the message receive mode when processing the received message.

Name

Gets the name of the subscription.

Prefetch​Count

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

Topic​Path

Gets the full pathname of the topic.

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(​String, ​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(​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()

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)

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

Add​Rule(​Rule​Description)

Adds a new rule to the SubscriptionDescription using the specified rule description.

Add​Rule(​String, ​Filter)

Adds a rule to the current subscription with the specified name and filter expression.

Add​Rule​Async(​Rule​Description)

Asynchronously adds a new rule to the SubscriptionDescription using the specified rule description.

Add​Rule​Async(​String, ​Filter)

Asynchronously adds a rule to the current subscription with the specified name and filter expression.

Complete(​Guid)

Completes processing of a message.

Complete​Async(​Guid)

Asynchronously completes processing of a message.

Complete​Batch(​IEnumerable<​Guid>)

Completes processing of a batch.

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

Asynchronously completes processing of a batch.

Create(​String, ​String)

Creates a new copy of SubscriptionClient with specified name and topic path.

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

Creates a new copy of SubscriptionClient with specified name, topic path and mode.

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

Creates a new copy of SubscriptionClient from a connection string with specified topic path, name and mode.

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

Creates a new copy of SubscriptionClient from a connection string with specified topic path and name.

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(​Guid, ​String, ​String)

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, ​IDictionary<​String,​Object>)

Asynchronously suspends the processing of a message.

Defer​Async(​Guid)

Asynchronously suspends the processing of a message.

Format​Dead​Letter​Path(​String, ​String)

Builds a format name deadletter path using the specified topic path and subscription name.

Format​Subscription​Path(​String, ​String)

Builds a format name subscription path using the specified topic path and subscription name.

Get​Message​Sessions()

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

Get​Message​Sessions(​Date​Time)

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

Get​Message​Sessions​Async()

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

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

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

On​Abort()

Executes the abort action.

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

Executes upon calling the BeginAcceptMessageSession operation.

On​Begin​Add​Rule(​Rule​Description, ​Time​Span, ​Async​Callback, ​Object)

Executes upon calling the BeginAddRule operation.

On​Begin​Close(​Time​Span, ​Async​Callback, ​Object)

Executes the begin close action.

On​Begin​Create​Receiver(​String, ​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​Get​Message​Sessions(​Date​Time, ​Async​Callback, ​Object)

Executes upon calling the BeginGetMessageSessions operation.

On​Begin​Remove​Rule(​String, ​Time​Span, ​Async​Callback, ​Object)

Begins removing a RuleDescription from a SubscriptionDescription through the run-time client protocol.

On​Begin​Remove​Rules​By​Tag(​String, ​Time​Span, ​Async​Callback, ​Object)

Begins removing a RuleDescription from a SubscriptionDescription through the run-time client protocol using a tag.

On​Close(​Time​Span)

Executes the close action.

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

Executes upon calling the EndAcceptMessageSession operation.

On​End​Add​Rule(​IAsync​Result)

Ends the asynchronous call to OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object).

On​End​Close(​IAsync​Result)

Executes the end close action.

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

Executes the end create receiver action.

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

Executes the end get message action.

On​End​Remove​Rule(​IAsync​Result)

Ends the asynchronous call to OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

On​End​Remove​Rules(​IAsync​Result)

Ends the asynchronous call to OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

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()

Returns without removing the first message in the queue.

Peek(​Int64)

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)

Returns without removing the first messages in a batch.

Peek​Batch(​Int64, ​Int32)

Returns without removing the first messages in a batch.

Peek​Batch​Async(​Int32)

Asynchronously returns without removing the first messages in a batch.

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

Asynchronously returns without removing the first messages in a batch.

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()

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​Async(​Time​Span)

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

Receive​Batch(​IEnumerable<​Int64>)

Receives a batch after the asynchronous operation.

Receive​Batch(​Int32)

Receives a batch after the asynchronous operation.

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

Receives a batch after the asynchronous operation.

Receive​Batch​Async(​Int32)

Asynchronously receives a set of messages (for batch processing).

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

Asynchronously receives a set of messages (for batch processing).

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

Asynchronously receives a set of messages (for batch processing).

Register​Session​Handler(​Type)

Registers the handler for the client session.

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

Registers the handler for the client session.

Register​Session​Handler​Async(​Type)

Asynchronously registers the handler for the client session.

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

Asynchronously registers the handler for the client session.

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

Registers the handler factory for the client session.

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

Registers the handler factory for the client session.

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

Asynchronously registers the handler factory for the client session.

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

Asynchronously registers the handler factory for the client session.

Remove​Rule(​String)

Removes the rule described by ruleName.

Remove​Rule​Async(​String)

Asynchronously removes the rule described by ruleName.

Renew​Message​Lock(​Guid)
Renew​Message​Lock​Async(​Guid)