Interface IConnection

interface IConnection {
    on(name: "close", cb: (() => void)): this;
    on(name: "connect", cb: (() => void)): this;
    on(name: "connection", cb: (() => void)): this;
    on(name: "open", cb: (() => void)): this;
    on(name: "client.acknowledged", cb: ((number: number) => void)): this;
    on(name: "client.error", cb: ((err: any) => void)): this;
    on(name: "client.sent", cb: ((number: number) => void)): this;
    on(name: "client.timeout", cb: (() => void)): this;
}

Hierarchy

  • EventEmitter
    • IConnection

Implemented by

Methods

on

Methods

on

  • on(name, cb): this

  • The connection has been closed manually. You have to start the connection again.

    Parameters

    • name: "close"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The connection is made.

    Parameters

    • name: "connect"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The connection is being (re)established or attempting to re-connect.

    Parameters

    • name: "connection"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The handle is open to do a manual start to connect.

    Parameters

    • name: "open"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The total acknowledged for this connection.

    Parameters

    • name: "client.acknowledged"
    • cb: ((number: number) => void)
        • (number): void

        • Parameters

          • number: number

          Returns void

    Returns this

  • on(name, cb): this

  • The connection has an error.

    Parameters

    • name: "client.error"
    • cb: ((err: any) => void)
        • (err): void

        • Parameters

          • err: any

          Returns void

    Returns this

  • on(name, cb): this

  • The total sent for this connection.

    Parameters

    • name: "client.sent"
    • cb: ((number: number) => void)
        • (number): void

        • Parameters

          • number: number

          Returns void

    Returns this

  • on(name, cb): this

  • The connection has timeout. Review "client.error" event for the reason.

    Parameters

    • name: "client.timeout"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

Settings

Member Visibility

On This Page

Methods