Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientEntityContextBase

Package version

Provides contextual information like the underlying amqp connection, cbs session, management session, tokenCredential, senders, receivers, etc. about the ServiceBus client.

internal

Hierarchy

  • ClientEntityContextBase

Index

Properties

Optional batchingReceiver

batchingReceiver: BatchingReceiver
property

{BatchingReceiver} [batchingReceiver] The ServiceBus receiver associated with the client entity for receiving a batch of messages.

clientId

clientId: string
property

{string} [clientId] Unique Id of the client for which this context is created

entityPath

entityPath: string
property

{string} entityPath - The name/path of the entity (queue/topic/subscription) to which the connection needs to happen.

expiredMessageSessions

expiredMessageSessions: Dictionary<boolean>
property

{Dictionary} expiredMessageSessions A dictionary that stores expired message sessions IDs.

isClosed

isClosed: boolean
property

{boolean} [isClosed] Denotes if close() was called on this client.

Optional isSessionEnabled

isSessionEnabled: undefined | false | true
property

{boolean} [isSessionEnabled] Indicates whether the client entity is session enabled. Default: false.

Optional managementClient

managementClient: ManagementClient
property

{ManagementClient} [managementClient] A reference to the management client ($management endpoint) on the underlying amqp connection for the ServiceBus Client.

messageSessions

messageSessions: Dictionary<MessageSession>
property

{Dictionary} messageSessions A dictionary of the MessageSession objects associated with this client.

namespace

property

{ConnectionContext} namespace Describes the context with common properties at the namespace level.

requestResponseLockedMessages

requestResponseLockedMessages: ConcurrentExpiringMap<string>
property

{ConcurrentExpiringMap} [requestResponseLockedMessages] A map of locked messages received using the management client.

Optional sender

property

{MessageSender} [sender] The ServiceBus sender associated with the client entity.

Optional streamingReceiver

streamingReceiver: StreamingReceiver
property

{StreamingReceiver} [receiver] The ServiceBus receiver associated with the client entity for streaming messages.

Generated using TypeDoc