Interface AmqpConnectionManager

interface AmqpConnectionManager {
    channelCount: number;
    connection: Connection;
    connectionOptions?: AmqpConnectionOptions;
    heartbeatIntervalInSeconds: number;
    reconnectTimeInSeconds: number;
    addListener(event, listener): this;
    addListener(event, listener): this;
    addListener(event, listener): this;
    addListener(event, listener): this;
    addListener(event, listener): this;
    addListener(event, listener): this;
    close(): Promise<void>;
    connect(options?): Promise<void>;
    createChannel(options?): default;
    isConnected(): boolean;
    listeners(eventName): Function[];
    on(event, listener): this;
    on(event, listener): this;
    on(event, listener): this;
    on(event, listener): this;
    on(event, listener): this;
    on(event, listener): this;
    once(event, listener): this;
    once(event, listener): this;
    once(event, listener): this;
    once(event, listener): this;
    once(event, listener): this;
    once(event, listener): this;
    prependListener(event, listener): this;
    prependListener(event, listener): this;
    prependListener(event, listener): this;
    prependListener(event, listener): this;
    prependListener(event, listener): this;
    prependListener(event, listener): this;
    prependOnceListener(event, listener): this;
    prependOnceListener(event, listener): this;
    prependOnceListener(event, listener): this;
    prependOnceListener(event, listener): this;
    prependOnceListener(event, listener): this;
    prependOnceListener(event, listener): this;
    reconnect(): void;
    removeListener(event, listener): this;
}

Implemented by

Properties

channelCount connection connectionOptions? heartbeatIntervalInSeconds reconnectTimeInSeconds

Methods

addListener close connect createChannel isConnected listeners on once prependListener prependOnceListener reconnect removeListener

Properties

Readonly channelCount

channelCount: number

Returns the number of registered channels.

Readonly connection

connection: Connection

The current connection.

Optional connectionOptions

connectionOptions?: AmqpConnectionOptions

heartbeatIntervalInSeconds

heartbeatIntervalInSeconds: number

reconnectTimeInSeconds

reconnectTimeInSeconds: number

Methods

addListener

  • addListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "connect"
    • listener: ConnectListener

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "connectFailed"
    • listener: ConnectFailedListener

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "blocked"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                reason: string;
            }
            • reason: string

          Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "unblocked"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                err: Error;
            }
            • err: Error

          Returns void

    Returns this

close

  • close(): Promise<void>

  • Returns Promise<void>

connect

  • connect(options?): Promise<void>

  • Parameters

    • Optional options: {
          timeout?: number;
      }
      • Optional timeout?: number

    Returns Promise<void>

createChannel

  • createChannel(options?): default

  • Parameters

    Returns default

isConnected

  • isConnected(): boolean

  • Returns boolean

listeners

  • listeners(eventName): Function[]

  • Parameters

    • eventName: string | symbol

    Returns Function[]

on

  • on(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "connect"
    • listener: ConnectListener

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "connectFailed"
    • listener: ConnectFailedListener

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "blocked"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                reason: string;
            }
            • reason: string

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "unblocked"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                err: Error;
            }
            • err: Error

          Returns void

    Returns this

once

  • once(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "connect"
    • listener: ConnectListener

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "connectFailed"
    • listener: ConnectFailedListener

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "blocked"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                reason: string;
            }
            • reason: string

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "unblocked"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                err: Error;
            }
            • err: Error

          Returns void

    Returns this

prependListener

  • prependListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "connect"
    • listener: ConnectListener

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "connectFailed"
    • listener: ConnectFailedListener

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "blocked"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                reason: string;
            }
            • reason: string

          Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "unblocked"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                err: Error;
            }
            • err: Error

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "connect"
    • listener: ConnectListener

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "connectFailed"
    • listener: ConnectFailedListener

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "blocked"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                reason: string;
            }
            • reason: string

          Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "unblocked"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((arg) => void)
        • (arg): void

        • Parameters

          • arg: {
                err: Error;
            }
            • err: Error

          Returns void

    Returns this

reconnect

  • reconnect(): void

  • Returns void

removeListener

  • removeListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Settings

Member Visibility

Theme

On This Page

channelCountconnectionconnectionOptionsheartbeatIntervalInSecondsreconnectTimeInSecondsaddListenercloseconnectcreateChannelisConnectedlistenersononceprependListenerprependOnceListenerreconnectremoveListener