Class PubSub

A publish/subscribe server for Nymph.

Written by Hunter Perrin for SciActive.

Author

Hunter Perrin [email protected]

Copyright

SciActive Inc

See

http://nymph.io/

Constructors

constructor

Properties

config nymph querySubs server uidSubs transactionPublishes

Methods

close handleRequest onClose onError onMessage initPublisher

Constructors

constructor

  • new PubSub(config, nymph, server): PubSub

  • Initialize Nymph PubSub.

    Parameters

    • config: Partial<Config>

      The PubSub configuration.

    • nymph: Nymph
    • server: server

    Returns PubSub

Properties

config

config: Config

The PubSub config.

nymph

nymph: Nymph

The Nymph instance.

ProtectedquerySubs

querySubs: {
    [etype: string]: {
        [query: string]: Map<ws.connection, QuerySubscriptionData>;
    };
} = {}

server

server: server

The WebSocket server.

ProtecteduidSubs

uidSubs: {
    [uidName: string]: Map<ws.connection, {
        count: boolean;
    }>;
} = {}

Protected StatictransactionPublishes

transactionPublishes: {
    config: Config;
    nymph: Nymph;
    payload: string;
}[] = []

Methods

close

handleRequest

  • handleRequest(request): void

  • Parameters

    • request: request

    Returns void

onClose

  • onClose(conn, description): void

  • Clean up after users who leave.

    Parameters

    • conn: connection
    • description: string

    Returns void

onError

  • onError(conn, e): void

  • Parameters

    • conn: connection
    • e: Error

    Returns void

onMessage

  • onMessage(from, msg): Promise<void>

  • Handle a message from a client.

    Parameters

    • from: connection
    • msg: Message

    Returns Promise<void>

StaticinitPublisher

  • initPublisher(config, nymph): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods