SubscriptionClient 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<wbr>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<wbr>Count

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

Topic<wbr>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<wbr>Async(Guid)

Asynchronously discards the message and relinquishes the message lock ownership.

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

Asynchronously discards the message and relinquishes the message lock ownership.

Accept<wbr>Message<wbr>Session()

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

Accept<wbr>Message<wbr>Session(String)

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

Accept<wbr>Message<wbr>Session(Time<wbr>Span)

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

Accept<wbr>Message<wbr>Session(String, Time<wbr>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<wbr>Message<wbr>Session<wbr>Async(String, Time<wbr>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<wbr>Message<wbr>Session<wbr>Async(Time<wbr>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<wbr>Message<wbr>Session<wbr>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<wbr>Message<wbr>Session<wbr>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<wbr>Rule(Rule<wbr>Description)

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

Add<wbr>Rule(String, Filter)

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

Add<wbr>Rule<wbr>Async(Rule<wbr>Description)

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

Add<wbr>Rule<wbr>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<wbr>Async(Guid)

Asynchronously completes processing of a message.

Complete<wbr>Batch(IEnumerable<Guid>)

Completes processing of a batch.

Complete<wbr>Batch<wbr>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<wbr>Mode)

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

Create<wbr>From<wbr>Connection<wbr>String(String, String, String, Receive<wbr>Mode)

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

Create<wbr>From<wbr>Connection<wbr>String(String, String, String)

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

Dead<wbr>Letter(Guid)

Moves the undelivered message to the dead letter queue.

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

Moves the undelivered message to the dead letter queue.

Dead<wbr>Letter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

Dead<wbr>Letter<wbr>Async(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

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

Asynchronously moves the undelivered message to the dead letter queue.

Dead<wbr>Letter<wbr>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<wbr>Async(Guid, IDictionary<String,Object>)

Asynchronously suspends the processing of a message.

Defer<wbr>Async(Guid)

Asynchronously suspends the processing of a message.

Format<wbr>Dead<wbr>Letter<wbr>Path(String, String)

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

Format<wbr>Subscription<wbr>Path(String, String)

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

Get<wbr>Message<wbr>Sessions()

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

Get<wbr>Message<wbr>Sessions(Date<wbr>Time)

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

Get<wbr>Message<wbr>Sessions<wbr>Async()

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

Get<wbr>Message<wbr>Sessions<wbr>Async(Date<wbr>Time)

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

On<wbr>Abort()

Executes the abort action.

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

Executes upon calling the BeginAcceptMessageSession operation.

On<wbr>Begin<wbr>Add<wbr>Rule(Rule<wbr>Description, Time<wbr>Span, Async<wbr>Callback, Object)

Executes upon calling the BeginAddRule operation.

On<wbr>Begin<wbr>Close(Time<wbr>Span, Async<wbr>Callback, Object)

Executes the begin close action.

On<wbr>Begin<wbr>Create<wbr>Receiver(String, String, Receive<wbr>Mode, Time<wbr>Span, Async<wbr>Callback, Object)

Executes the begin create receiver action.

On<wbr>Begin<wbr>Create<wbr>Receiver(Receive<wbr>Mode, Time<wbr>Span, Async<wbr>Callback, Object)

Executes the begin create receiver action.

On<wbr>Begin<wbr>Get<wbr>Message<wbr>Sessions(Date<wbr>Time, Async<wbr>Callback, Object)

Executes upon calling the BeginGetMessageSessions operation.

On<wbr>Begin<wbr>Remove<wbr>Rule(String, Time<wbr>Span, Async<wbr>Callback, Object)

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

On<wbr>Begin<wbr>Remove<wbr>Rules<wbr>ByTag(String, Time<wbr>Span, Async<wbr>Callback, Object)

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

On<wbr>Close(Time<wbr>Span)

Executes the close action.

On<wbr>End<wbr>Accept<wbr>Message<wbr>Session(IAsync<wbr>Result)

Executes upon calling the EndAcceptMessageSession operation.

On<wbr>End<wbr>Add<wbr>Rule(IAsync<wbr>Result)

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

On<wbr>End<wbr>Close(IAsync<wbr>Result)

Executes the end close action.

On<wbr>End<wbr>Create<wbr>Receiver(IAsync<wbr>Result)

Executes the end create receiver action.

On<wbr>End<wbr>Get<wbr>Message<wbr>Sessions(IAsync<wbr>Result)

Executes the end get message action.

On<wbr>End<wbr>Remove<wbr>Rule(IAsync<wbr>Result)

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

On<wbr>End<wbr>Remove<wbr>Rules(IAsync<wbr>Result)

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

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

Processes a message in an event-driven message pump.

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

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

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

Asynchronously processes a message.

On<wbr>Message<wbr>Async(Func<Brokered<wbr>Message,Task>, On<wbr>Message<wbr>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<wbr>Async()

Asynchronously returns without removing the first message in the queue.

Peek<wbr>Async(Int64)

Asynchronously returns without removing the first message in the queue.

Peek<wbr>Batch(Int32)

Returns without removing the first messages in a batch.

Peek<wbr>Batch(Int64, Int32)

Returns without removing the first messages in a batch.

Peek<wbr>Batch<wbr>Async(Int32)

Asynchronously returns without removing the first messages in a batch.

Peek<wbr>Batch<wbr>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<wbr>Span)

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

Receive<wbr>Async()

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

Receive<wbr>Async(Int64)

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

Receive<wbr>Async(Time<wbr>Span)

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

Receive<wbr>Batch(IEnumerable<Int64>)

Receives a batch after the asynchronous operation.

Receive<wbr>Batch(Int32)

Receives a batch after the asynchronous operation.

Receive<wbr>Batch(Int32, Time<wbr>Span)

Receives a batch after the asynchronous operation.

Receive<wbr>Batch<wbr>Async(Int32)

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

Receive<wbr>Batch<wbr>Async(Int32, Time<wbr>Span)

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

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

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

Register<wbr>Session<wbr>Handler(Type)

Registers the handler for the client session.

Register<wbr>Session<wbr>Handler(Type, Session<wbr>Handler<wbr>Options)

Registers the handler for the client session.

Register<wbr>Session<wbr>Handler<wbr>Async(Type)

Asynchronously registers the handler for the client session.

Register<wbr>Session<wbr>Handler<wbr>Async(Type, Session<wbr>Handler<wbr>Options)

Asynchronously registers the handler for the client session.

Register<wbr>Session<wbr>Handler<wbr>Factory(IMessage<wbr>Session<wbr>Async<wbr>Handler<wbr>Factory, Session<wbr>Handler<wbr>Options)

Registers the handler factory for the client session.

Register<wbr>Session<wbr>Handler<wbr>Factory(IMessage<wbr>Session<wbr>Handler<wbr>Factory, Session<wbr>Handler<wbr>Options)

Registers the handler factory for the client session.

Register<wbr>Session<wbr>Handler<wbr>Factory<wbr>Async(IMessage<wbr>Session<wbr>Async<wbr>Handler<wbr>Factory, Session<wbr>Handler<wbr>Options)

Asynchronously registers the handler factory for the client session.

Register<wbr>Session<wbr>Handler<wbr>Factory<wbr>Async(IMessage<wbr>Session<wbr>Handler<wbr>Factory, Session<wbr>Handler<wbr>Options)

Asynchronously registers the handler factory for the client session.

Remove<wbr>Rule(String)

Removes the rule described by ruleName.

Remove<wbr>Rule<wbr>Async(String)

Asynchronously removes the rule described by ruleName.

Renew<wbr>Message<wbr>Lock(Guid)
Renew<wbr>Message<wbr>Lock<wbr>Async(Guid)

Extension Methods

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