Class AMQPClient

AMQP 0-9-1 client over TCP socket.

Hierarchy

AMQPBaseClient
- AMQPClient

Index

Constructors

constructor

new AMQPClient(url, tlsOptions?): AMQPClient
Parameters
- url: string
  
  uri to the server, example: amqp://user:passwd@localhost:5672/vhost
- Optional tlsOptions: AMQPTlsOptions
Returns AMQPClient
Overrides AMQPBaseClient.constructor
- Defined in src/amqp-socket-client.ts:26

Properties

`Optional` blocked

blocked?: string

`Readonly` bufferPool

bufferPool: AMQPView[] = []

channelMax

channelMax: number = 0

channels

channels: AMQPChannel[]

`Protected` `Optional` closePromise

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

Type declaration

- (value?): void
- Parameters
  - Optional value: void
  Returns void

Type declaration

- (err): void
- Parameters
  - err: Error
  Returns void

closed

closed: boolean = true

`Protected` `Optional` connectPromise

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

Type declaration

- (conn): void
- Parameters
  - conn: AMQPBaseClient
  Returns void

Type declaration

- (err): void
- Parameters
  - err: Error
  Returns void

`Private` `Readonly` frameBuffer

frameBuffer: Buffer

frameMax

frameMax: number

`Private` framePos

framePos: number

`Private` frameSize

frameSize: number

heartbeat

heartbeat: number

`Readonly` host

host: string

`Private` `Readonly` insecure

insecure: boolean

logger

logger: undefined | null | Logger = console

`Optional` name

name?: string

`Protected` `Optional` onUpdateSecretOk

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

Type declaration

- (value?): void
- Parameters
  - Optional value: void
  Returns void

onerror

onerror: ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: AMQPError
  Returns void

password

password: string

`Optional` platform

platform?: string

`Readonly` port

port: number

`Optional` socket

socket?: Socket

`Readonly` textEncoder

textEncoder: TextEncoder = ...

Used for string -> arraybuffer when publishing

`Readonly` tls

tls: boolean

`Readonly` tlsOptions

tlsOptions: undefined | AMQPTlsOptions

username

username: string

vhost

vhost: string

Methods

channel

channel(id?): Promise<AMQPChannel>
Open a channel
Parameters
- Optional id: number
  
  An existing or non existing specific channel
Returns Promise<AMQPChannel>
Inherited from AMQPBaseClient.channel
- Defined in src/amqp-base-client.ts:63

close

close(reason?, code?): Promise<void>
Gracefully close the AMQP connection
Parameters
- Optional reason: string = ""
  
  might be logged by the server
- code: number = 200
Returns Promise<void>
Inherited from AMQPBaseClient.close
- Defined in src/amqp-base-client.ts:85

`Protected` closeSocket

closeSocket(): void
Returns void
Overrides AMQPBaseClient.closeSocket
- Defined in src/amqp-socket-client.ts:163

connect

connect(): Promise<AMQPBaseClient>
Returns Promise<AMQPBaseClient>
Overrides AMQPBaseClient.connect
- Defined in src/amqp-socket-client.ts:50

`Private` connectSocket

connectSocket(): Socket
Returns Socket
- Defined in src/amqp-socket-client.ts:72

`Private` onRead

onRead(buf): boolean
Parameters
- buf: Buffer
Returns boolean
- Defined in src/amqp-socket-client.ts:94

updateSecret

updateSecret(newSecret, reason): Promise<unknown>
Parameters
- newSecret: string
- reason: string
Returns Promise<unknown>
Inherited from AMQPBaseClient.updateSecret
- Defined in src/amqp-base-client.ts:108

Class AMQPClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional tlsOptions: AMQPTlsOptions

Returns AMQPClient

Properties

Optional blocked

Readonly bufferPool

channelMax

channels

Protected Optional closePromise

Type declaration

Parameters

Optional value: void

Returns void

Type declaration

Parameters

err: Error

Returns void

closed

Protected Optional connectPromise

Type declaration

Parameters

conn: AMQPBaseClient

Returns void

Type declaration

Parameters

err: Error

Returns void

Private Readonly frameBuffer

frameMax

Private framePos

Private frameSize

heartbeat

Readonly host

Private Readonly insecure

logger

Optional name

Protected Optional onUpdateSecretOk

Type declaration

Parameters

Optional value: void

Returns void

onerror

Type declaration

Parameters

error: AMQPError

Returns void

password

Optional platform

Readonly port

Optional socket

Readonly textEncoder

Readonly tls

Readonly tlsOptions

username

vhost

Methods

channel

Parameters

Optional id: number

Returns Promise<AMQPChannel>

close

Parameters

Optional reason: string = ""

code: number = 200

Returns Promise<void>

Protected closeSocket

Returns void

connect

Returns Promise<AMQPBaseClient>

Private connectSocket

Returns Socket

`Optional` tlsOptions: AMQPTlsOptions

`Optional` blocked

`Readonly` bufferPool

`Protected` `Optional` closePromise

`Optional` value: void

`Protected` `Optional` connectPromise

`Private` `Readonly` frameBuffer

`Private` framePos

`Private` frameSize

`Readonly` host

`Private` `Readonly` insecure

`Optional` name

`Protected` `Optional` onUpdateSecretOk

`Optional` value: void

`Optional` platform

`Readonly` port

`Optional` socket

`Readonly` textEncoder

`Readonly` tls

`Readonly` tlsOptions

`Optional` id: number

`Optional` reason: string = ""

`Protected` closeSocket

`Private` connectSocket

`Private` onRead