Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectionContextBase

Package version

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

Hierarchy

  • ConnectionContextBase

Index

Properties

cbsSession

cbsSession: CbsClient
property

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

config

property

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

connection

connection: Connection
property

{Connection} connection The underlying AMQP connection.

connectionId

connectionId: string
property

{string} connectionId The amqp connection id that uniquely identifies the connection within a process.

connectionLock

connectionLock: string
property

{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.

negotiateClaimLock

negotiateClaimLock: string
property

{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.

refreshConnection

refreshConnection: () => void

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

Type declaration

    • (): void
    • Returns void

wasConnectionCloseCalled

wasConnectionCloseCalled: boolean
property

{boolean} wasConnectionCloseCalled Indicates whether the close() method was called on the connection object.

Generated using TypeDoc