Class AMQPWebSocketClient

WebSocket client for AMQP 0-9-1 servers

Hierarchy

AMQPBaseClient
- AMQPWebSocketClient

Index

Constructors

constructor

new AMQPWebSocketClient(url, vhost?, username?, password?, name?, frameMax?, heartbeat?): AMQPWebSocketClient
Parameters
- url: string
  
  to the websocket endpoint, example: wss://server/ws/amqp
- Optional vhost: string
- Optional username: string
- Optional password: string
- Optional name: string
- Optional frameMax: number
- Optional heartbeat: number
Returns AMQPWebSocketClient
Overrides AMQPBaseClient.constructor
- Defined in src/amqp-websocket-client.ts:28
new AMQPWebSocketClient(init): AMQPWebSocketClient
Parameters
- init: AMQPWebSocketInit
Returns AMQPWebSocketClient
Overrides AMQPBaseClient.constructor
- Defined in src/amqp-websocket-client.ts:29

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` frameBuffer

frameBuffer: Uint8Array

frameMax

frameMax: number

`Private` framePos

framePos: number = 0

`Private` frameSize

frameSize: number = 0

heartbeat

heartbeat: number

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

`Private` `Optional` socket

socket?: WebSocket

`Readonly` textEncoder

textEncoder: TextEncoder = ...

Used for string -> arraybuffer when publishing

`Readonly` url

url: string

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-websocket-client.ts:89

connect

connect(): Promise<AMQPBaseClient>
Establish a AMQP connection over WebSocket

Returns Promise<AMQPBaseClient>
Overrides AMQPBaseClient.connect
- Defined in src/amqp-websocket-client.ts:48

`Private` handleMessage

handleMessage(event): void
Parameters
- event: MessageEvent<any>
Returns void
- Defined in src/amqp-websocket-client.ts:95

send

send(bytes): Promise<void>
Parameters
- bytes: Uint8Array
  
  to send
Returns Promise<void>
fulfilled when the data is enqueued
Overrides AMQPBaseClient.send
- Defined in src/amqp-websocket-client.ts:73

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

`Static` platform

platform(): string
Returns string
- Defined in src/amqp-websocket-client.ts:146

Class AMQPWebSocketClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional vhost: string

Optional username: string

Optional password: string

Optional name: string

Optional frameMax: number

Optional heartbeat: number

Returns AMQPWebSocketClient

Parameters

init: AMQPWebSocketInit

Returns AMQPWebSocketClient

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 frameBuffer

frameMax

Private framePos

Private frameSize

heartbeat

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

Private Optional socket

Readonly textEncoder

Readonly url

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

`Optional` vhost: string

`Optional` username: string

`Optional` password: string

`Optional` name: string

`Optional` frameMax: number

`Optional` heartbeat: number

`Optional` blocked

`Readonly` bufferPool

`Protected` `Optional` closePromise

`Optional` value: void

`Protected` `Optional` connectPromise

`Private` frameBuffer

`Private` framePos

`Private` frameSize

`Optional` name

`Protected` `Optional` onUpdateSecretOk

`Optional` value: void

`Optional` platform

`Private` `Optional` socket

`Readonly` textEncoder

`Readonly` url

`Optional` id: number

`Optional` reason: string = ""

`Protected` closeSocket

`Private` handleMessage

`Static` platform