SubscriptionClient Class

 

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

Namespace:   Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

System.Object
  Microsoft.ServiceBus.Messaging.ClientEntity
    Microsoft.ServiceBus.Messaging.SubscriptionClient

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubpropertyIsClosed

(Inherited from ClientEntity.)

System_CAPS_pubpropertyMessagingFactory

Gets the messaging factory used to create this subscription client.

System_CAPS_pubpropertyMode

Gets the message receive mode when processing the received message.

System_CAPS_pubpropertyName

Gets the name of the subscription.

System_CAPS_pubpropertyPrefetchCount

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

System_CAPS_pubpropertyRetryPolicy

(Inherited from ClientEntity.)

System_CAPS_protpropertyThisLock

(Inherited from ClientEntity.)

System_CAPS_pubpropertyTopicPath

Gets the full pathname of the topic.

NameDescription
System_CAPS_pubmethodAbandon(Guid)

Discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandon(Guid, IDictionary<String, Object>)

Discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandonAsync(Guid)

Asynchronously discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandonAsync(Guid, IDictionary<String, Object>)

Asynchronously discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbort()

Performs abort functionality on the messaging entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodAcceptMessageSession()

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

System_CAPS_pubmethodAcceptMessageSession(String)

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

System_CAPS_pubmethodAcceptMessageSession(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.

System_CAPS_pubmethodAcceptMessageSession(TimeSpan)

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

System_CAPS_pubmethodAcceptMessageSessionAsync()

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

System_CAPS_pubmethodAcceptMessageSessionAsync(String)

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

System_CAPS_pubmethodAcceptMessageSessionAsync(String, TimeSpan)

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

System_CAPS_pubmethodAcceptMessageSessionAsync(TimeSpan)

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

System_CAPS_pubmethodAddRule(RuleDescription)

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

System_CAPS_pubmethodAddRule(String, Filter)

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

System_CAPS_pubmethodAddRuleAsync(RuleDescription)

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

System_CAPS_pubmethodAddRuleAsync(String, Filter)

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

System_CAPS_pubmethodClose()

Sends a cleanup message to Service Bus to signal the completion of the usage of an entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodCloseAsync()

Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodComplete(Guid)

Completes processing of a message.

System_CAPS_pubmethodCompleteAsync(Guid)

Asynchronously completes processing of a message.

System_CAPS_pubmethodCompleteBatch(IEnumerable<Guid>)

Completes processing of a batch.

System_CAPS_pubmethodCompleteBatchAsync(IEnumerable<Guid>)

Asynchronously completes processing of a batch.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String, String)

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

System_CAPS_pubmethodSystem_CAPS_staticCreate(String, String, ReceiveMode)

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

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String, String, String)

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

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String, String, String, ReceiveMode)

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

System_CAPS_pubmethodDeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(Guid, IDictionary<String, Object>)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid, IDictionary<String, Object>)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid, String, String)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDefer(Guid)

Suspends the processing of a message.

System_CAPS_pubmethodDefer(Guid, IDictionary<String, Object>)

Suspends the processing of a message.

System_CAPS_pubmethodDeferAsync(Guid)

Asynchronously suspends the processing of a message.

System_CAPS_pubmethodDeferAsync(Guid, IDictionary<String, Object>)

Asynchronously suspends the processing of a message.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFault()

For internal use only. Do not inherit from this class.(Inherited from ClientEntity.)

System_CAPS_protmethodFinalize()

(Inherited from ClientEntity.)

System_CAPS_pubmethodSystem_CAPS_staticFormatDeadLetterPath(String, String)

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

System_CAPS_pubmethodSystem_CAPS_staticFormatSubscriptionPath(String, String)

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

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetMessageSessions()

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

System_CAPS_pubmethodGetMessageSessions(DateTime)

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

System_CAPS_pubmethodGetMessageSessionsAsync()

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

System_CAPS_pubmethodGetMessageSessionsAsync(DateTime)

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Executes the abort action.(Overrides ClientEntity.OnAbort().)

System_CAPS_protmethodOnBeginAcceptMessageSession(String, ReceiveMode, TimeSpan, TimeSpan, AsyncCallback, Object)

Executes upon calling the BeginAcceptMessageSession operation.

System_CAPS_protmethodOnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)

Executes upon calling the BeginAddRule operation.

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback, Object)

Executes the begin close action.(Overrides ClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)

System_CAPS_protmethodOnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin create receiver action.

System_CAPS_protmethodOnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin create receiver action.

System_CAPS_protmethodOnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

Executes upon calling the BeginGetMessageSessions operation.

System_CAPS_protmethodOnBeginOpen(TimeSpan, AsyncCallback, Object)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)

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

System_CAPS_protmethodOnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object)

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

System_CAPS_protmethodOnClose(TimeSpan)

Executes the close action.(Overrides ClientEntity.OnClose(TimeSpan).)

System_CAPS_protmethodOnClosed()

(Inherited from ClientEntity.)

System_CAPS_protmethodOnEndAcceptMessageSession(IAsyncResult)

Executes upon calling the EndAcceptMessageSession operation.

System_CAPS_protmethodOnEndAddRule(IAsyncResult)

Ends the asynchronous call to OnBeginAddRule.

System_CAPS_protmethodOnEndClose(IAsyncResult)

Executes the end close action.(Overrides ClientEntity.OnEndClose(IAsyncResult).)

System_CAPS_protmethodOnEndCreateReceiver(IAsyncResult)

Executes the end create receiver action.

System_CAPS_protmethodOnEndGetMessageSessions(IAsyncResult)

Executes the end get message action.

System_CAPS_protmethodOnEndOpen(IAsyncResult)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnEndRemoveRule(IAsyncResult)

Ends the asynchronous call to OnBeginRemoveRule.

System_CAPS_protmethodOnEndRemoveRules(IAsyncResult)

Ends the asynchronous call to OnBeginRemoveRule.

System_CAPS_protmethodOnFaulted()

(Inherited from ClientEntity.)

System_CAPS_pubmethodOnMessage(Action<BrokeredMessage>)

Processes a message in an event-driven message pump.

System_CAPS_pubmethodOnMessage(Action<BrokeredMessage>, OnMessageOptions)

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

System_CAPS_pubmethodOnMessageAsync(Func<BrokeredMessage, Task>)

Asynchronously processes a message.

System_CAPS_pubmethodOnMessageAsync(Func<BrokeredMessage, Task>, OnMessageOptions)

Asynchronously processes a message.

System_CAPS_protmethodOnOpen(TimeSpan)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnOpened()

(Inherited from ClientEntity.)

System_CAPS_pubmethodPeek()

Returns without removing the first message in the queue.

System_CAPS_pubmethodPeek(Int64)

Returns without removing the first message in the queue.

System_CAPS_pubmethodPeekAsync()

Asynchronously returns without removing the first message in the queue.

System_CAPS_pubmethodPeekAsync(Int64)

Asynchronously returns without removing the first message in the queue.

System_CAPS_pubmethodPeekBatch(Int32)

Returns without removing the first messages in a batch.

System_CAPS_pubmethodPeekBatch(Int64, Int32)

Returns without removing the first messages in a batch.

System_CAPS_pubmethodPeekBatchAsync(Int32)

Asynchronously returns without removing the first messages in a batch.

System_CAPS_pubmethodPeekBatchAsync(Int64, Int32)

Asynchronously returns without removing the first messages in a batch.

System_CAPS_pubmethodReceive()
System_CAPS_pubmethodReceive(Int64)
System_CAPS_pubmethodReceive(TimeSpan)
System_CAPS_pubmethodReceiveAsync()

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

System_CAPS_pubmethodReceiveAsync(Int64)

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

System_CAPS_pubmethodReceiveAsync(TimeSpan)

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

System_CAPS_pubmethodReceiveBatch(IEnumerable<Int64>)

Receives a batch after the asynchronous operation.

System_CAPS_pubmethodReceiveBatch(Int32)

Receives a batch after the asynchronous operation.

System_CAPS_pubmethodReceiveBatch(Int32, TimeSpan)

Receives a batch after the asynchronous operation.

System_CAPS_pubmethodReceiveBatchAsync(IEnumerable<Int64>)

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

System_CAPS_pubmethodReceiveBatchAsync(Int32)

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

System_CAPS_pubmethodReceiveBatchAsync(Int32, TimeSpan)

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

System_CAPS_pubmethodRegisterSessionHandler(Type)

Registers the handler for the client session.

System_CAPS_pubmethodRegisterSessionHandler(Type, SessionHandlerOptions)

Registers the handler for the client session.

System_CAPS_pubmethodRegisterSessionHandlerAsync(Type)

Asynchronously registers the handler for the client session.

System_CAPS_pubmethodRegisterSessionHandlerAsync(Type, SessionHandlerOptions)

Asynchronously registers the handler for the client session.

System_CAPS_pubmethodRegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registers the handler factory for the client session.

System_CAPS_pubmethodRegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registers the handler factory for the client session.

System_CAPS_pubmethodRegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Asynchronously registers the handler factory for the client session.

System_CAPS_pubmethodRegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

Asynchronously registers the handler factory for the client session.

System_CAPS_pubmethodRemoveRule(String)

Removes the rule described by ruleName.

System_CAPS_pubmethodRemoveRuleAsync(String)

Asynchronously removes the rule described by ruleName.

System_CAPS_pubmethodRenewMessageLock(Guid)

System_CAPS_pubmethodRenewMessageLockAsync(Guid)

System_CAPS_protmethodThrowIfClosed()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposed()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposedOrImmutable()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfFaulted()

(Inherited from ClientEntity.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: