ConnectionContextBase interface

Package:

@azure/amqp-common

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 unqiue lock name per connection that is used to acquire the lock for establishing an aqmp connection per client if one does not exist.
dataTransformer	A DataTransformer object that has methods named encode Responsible for encoding the AMQP message before sending it on the wire. decode Responsible for decoding the received AMQP message before passing it to the customer.
negotiateClaimLock	The unqiue 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.
tokenProvider	The TokenProvider to be used for getting tokens for authentication for the EventHub client.
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 unqiue lock name per connection that is used to acquire the lock for establishing an aqmp connection per client if one does not exist.

connectionLock: string

Property Value

string

dataTransformer

A DataTransformer object that has methods named

• encode Responsible for encoding the AMQP message before sending it on the wire.
• decode Responsible for decoding the received AMQP message before passing it to the customer.

dataTransformer: DataTransformer

Property Value

DataTransformer

negotiateClaimLock

The unqiue 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

tokenProvider

The TokenProvider to be used for getting tokens for authentication for the EventHub client.

tokenProvider: TokenProvider

Property Value

TokenProvider

wasConnectionCloseCalled

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

wasConnectionCloseCalled: boolean

Property Value

boolean