Class AMQPClient

AMQP 0-9-1 client over TCP socket.

Hierarchy

  • AMQPBaseClient
    • AMQPClient

Constructors

constructor

Properties

blocked? bufferPool channelMax channels closed closePromise? connectPromise? frameMax heartbeat host logger name? onerror onUpdateSecretOk? password platform? port socket? textEncoder tls tlsOptions username vhost

Methods

channel close closeSocket connect updateSecret

Constructors

constructor

Properties

Optionalblocked

blocked?: string

ReadonlybufferPool

bufferPool: AMQPView[] = []

channelMax

channelMax: number = 0

channels

channels: AMQPChannel[]

closed

closed: boolean = true

Protected OptionalclosePromise

closePromise?: [(value?: void) => void, (err: Error) => void]

Protected OptionalconnectPromise

connectPromise?: [(conn: AMQPBaseClient) => void, (err: Error) => void]

frameMax

frameMax: number

heartbeat

heartbeat: number

Readonlyhost

host: string

logger

logger: undefined | null | Logger = console

Optionalname

name?: string

onerror

onerror: (error: AMQPError) => void

Protected OptionalonUpdateSecretOk

onUpdateSecretOk?: (value?: void) => void

password

password: string

Optionalplatform

platform?: string

Readonlyport

port: number

Optionalsocket

socket?: Socket

ReadonlytextEncoder

textEncoder: TextEncoder = ...

Used for string -> arraybuffer when publishing

Readonlytls

tls: boolean

ReadonlytlsOptions

tlsOptions: undefined | AMQPTlsOptions

username

username: string

vhost

vhost: string

Methods

channel

close

  • close(reason?: string, code?: number): Promise<void>

    Gracefully close the AMQP connection

    Parameters

    • Optionalreason: string = ""

      might be logged by the server

    • code: number = 200

    Returns Promise<void>

ProtectedcloseSocket

connect

  • connect(): Promise<AMQPBaseClient>

    Try establish a connection

    Returns Promise<AMQPBaseClient>

updateSecret

  • updateSecret(newSecret: string, reason: string): Promise<unknown>

    Parameters

    • newSecret: string
    • reason: string

    Returns Promise<unknown>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods