Nymph.js 1.0.0-beta.113
    Preparing search index...

    Class PubSub

    A publish/subscribe server for Nymph.

    Written by Hunter Perrin for SciActive.

    Hunter Perrin [email protected]

    SciActive Inc

    http://nymph.io/

    Index

    Constructors

    constructor

    Properties

    config nymph querySubs server uidSubs transactionPublishes

    Methods

    close handleRequest onClose onError onMessage initPublisher

    Constructors

    • Initialize Nymph PubSub.

      Parameters

      • config: Partial<Config>

        The PubSub configuration.

      • nymph: Nymph
      • server: server

      Returns PubSub

    Properties

    config: Config

    The PubSub config.

    nymph: Nymph

    The Nymph instance.

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

    The WebSocket server.

    uidSubs: { [uidName: string]: Map<connection, { count: boolean }> } = {}
    transactionPublishes: { config: Config; nymph: Nymph; payload: string }[] = []

    Methods

    • Returns void

    • Parameters

      • request: request

      Returns void

    • Clean up after users who leave.

      Parameters

      • conn: connection
      • description: string

      Returns void

    • Parameters

      • conn: connection
      • e: Error

      Returns void

    • Handle a message from a client.

      Parameters

      • from: connection
      • msg: Message

      Returns Promise<void>

    • Parameters

      Returns () => void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods