ConnectionContextBase interface

Package:

@azure/core-amqp

Provides contextual information like the underlying amqp connection, cbs session, tokenProvider, Connection config, data transformer, etc.

Properties

cbsSession	A reference to the cbs session ($cbs endpoint) on the underlying AMQP connection for the EventHub Client.
config	The EventHub connection config that is created after parsing the connection string.
connection	The underlying AMQP connection.
connectionId	The amqp connection id that uniquely identifies the connection within a process.
connectionLock	The unique lock name per connection that is used to acquire the lock for establishing an amqp connection per client if one does not exist.
negotiateClaimLock	The unique lock name per connection that is used to acquire the lock for negotiating cbs claim by an entity on that connection.
refreshConnection	Updates the context to use a new underlying AMQP connection and new cbs session.
wasConnectionCloseCalled	Indicates whether the close() method was called on the connection object.

Property Details

cbsSession

A reference to the cbs session ($cbs endpoint) on the underlying AMQP connection for the EventHub Client.

cbsSession: CbsClient

Property Value

CbsClient

config

The EventHub connection config that is created after parsing the connection string.

config: ConnectionConfig

Property Value

ConnectionConfig

connection

The underlying AMQP connection.

connection: Connection

Property Value

Connection

connectionId

The amqp connection id that uniquely identifies the connection within a process.

connectionId: string

Property Value

string

connectionLock

The unique lock name per connection that is used to acquire the lock for establishing an amqp connection per client if one does not exist.

connectionLock: string

Property Value

string

negotiateClaimLock

The unique lock name per connection that is used to acquire the lock for negotiating cbs claim by an entity on that connection.

negotiateClaimLock: string

Property Value

string

refreshConnection

Updates the context to use a new underlying AMQP connection and new cbs session.

refreshConnection: () => void

Property Value

() => void

wasConnectionCloseCalled

Indicates whether the close() method was called on the connection object.

wasConnectionCloseCalled: boolean

Property Value

boolean