Class AMQPWebSocketClient

WebSocket client for AMQP 0-9-1 servers

Hierarchy

  • AMQPBaseClient
    • AMQPWebSocketClient

Constructors

constructor

Properties

blocked? bufferPool channelMax channels closed closePromise? connectPromise? frameMax heartbeat logger name? onerror onUpdateSecretOk? password platform? textEncoder url username vhost

Methods

channel close closeSocket connect send updateSecret platform

Constructors

constructor

  • new AMQPWebSocketClient(
        url: string,
        vhost?: string,
        username?: string,
        password?: string,
        name?: string,
        frameMax?: number,
        heartbeat?: number,
    ): AMQPWebSocketClient

    Parameters

    • url: string

      to the websocket endpoint, example: wss://server/ws/amqp

    • Optionalvhost: string
    • Optionalusername: string
    • Optionalpassword: string
    • Optionalname: string
    • OptionalframeMax: number
    • Optionalheartbeat: number

    Returns AMQPWebSocketClient

  • new AMQPWebSocketClient(init: AMQPWebSocketInit): AMQPWebSocketClient

    Parameters

    • init: AMQPWebSocketInit

    Returns AMQPWebSocketClient

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

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

ReadonlytextEncoder

textEncoder: TextEncoder = ...

Used for string -> arraybuffer when publishing

Readonlyurl

url: string

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>

    Establish a AMQP connection over WebSocket

    Returns Promise<AMQPBaseClient>

send

  • send(bytes: Uint8Array): Promise<void>

    Parameters

    • bytes: Uint8Array

      to send

    Returns Promise<void>

    fulfilled when the data is enqueued

updateSecret

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

    Parameters

    • newSecret: string
    • reason: string

    Returns Promise<unknown>

Staticplatform

Settings

Member Visibility

On This Page

Constructors
Properties
Methods