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

new PubSub(config, nymph, server): PubSub
Initialize Nymph PubSub.
Parameters
- config: Partial<Config>
  The PubSub configuration.
- nymph: Nymph
- server: server
Returns PubSub
- Defined in PubSub.ts:392

Properties

config

config: Config

The PubSub config.

nymph

nymph: Nymph

The Nymph instance.

`Protected` querySubs

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

Type declaration

[etype: string]: {
[query: string]: Map<connection, QuerySubscriptionData>;
}
- [query: string]: Map<connection, QuerySubscriptionData>

server

server: server

The WebSocket server.

`Private` sessions

sessions: Map<connection, {
authToken: string;
switchToken?: string;
}> = ...

Type declaration

authToken: string
Optional switchToken?: string

`Protected` uidSubs

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

Type declaration

[uidName: string]: Map<connection, {
count: boolean;
}>

`Protected` `Static` transactionPublishes

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

Type declaration

config: Config
nymph: Nymph
payload: string

Methods

close

close(): void
Returns void
- Defined in PubSub.ts:404

`Private` findQRefQueries

findQRefQueries(options, ...selectors): [MessageOptions, ...Selector[]][]
Parameters
- options: MessageOptions
- Rest ...selectors: Selector[]
Returns [MessageOptions, ...Selector[]][]
- Defined in PubSub.ts:1389

`Private` handleAuthentication

handleAuthentication(from, data): void
Handle an authentication from a client.
Parameters
- from: connection
- data: AuthenticateMessageData
Returns void
- Defined in PubSub.ts:570

`Private` handlePublish

handlePublish(from, msg, data): Promise<void>
Handle a publish from a client.
Parameters
- from: connection
- msg: Message
- data: PublishMessageData
Returns Promise<void>
- Defined in PubSub.ts:978

`Private` handlePublishEntity

handlePublishEntity(from, data): Promise<void>
Handle an entity publish from a client.
Parameters
- from: connection
- data: PublishEntityMessageData
Returns Promise<void>
- Defined in PubSub.ts:1020

`Private` handlePublishUid

handlePublishUid(from, data): Promise<void>
Handle a UID publish from a client.
Parameters
- from: connection
- data: PublishUidMessageData
Returns Promise<void>
- Defined in PubSub.ts:1278

handleRequest

handleRequest(request): void
Parameters
- request: request
Returns void
- Defined in PubSub.ts:408

`Private` handleSubscription

handleSubscription(from, data): Promise<void>
Handle a subscribe or unsubscribe from a client.
Parameters
- from: connection
- data: SubscribeMessageData
Returns Promise<void>
- Defined in PubSub.ts:587

`Private` handleSubscriptionQuery

handleSubscriptionQuery(from, data, qrefParent?): Promise<void>
Handle a subscribe or unsubscribe for a query from a client.
Parameters
- from: connection
- data: QuerySubscribeMessageData
- Optional qrefParent: {
  etype: string;
  query: string;
  }
  - etype: string
  - query: string
Returns Promise<void>
- Defined in PubSub.ts:619

`Private` handleSubscriptionUid

handleSubscriptionUid(from, data): Promise<void>
Handle a subscribe or unsubscribe for a UID from a client.
Parameters
- from: connection
- data: UidSubscribeMessageData
Returns Promise<void>
- Defined in PubSub.ts:861

onClose

onClose(conn, description): void
Clean up after users who leave.
Parameters
- conn: connection
- description: string
Returns void
- Defined in PubSub.ts:473

onError

onError(conn, e): void
Parameters
- conn: connection
- e: Error
Returns void
- Defined in PubSub.ts:559

onMessage

onMessage(from, msg): Promise<void>
Handle a message from a client.
Parameters
- from: connection
- msg: Message
Returns Promise<void>
- Defined in PubSub.ts:443

`Private` relay

relay(message): void
Relay publish data to other servers.
Parameters
- message: Message
Returns void
- Defined in PubSub.ts:1348

`Private` translateQRefSelectors

translateQRefSelectors(client, selectors): Selector[]
This translates qref selectors into ref selectors using the "current" GUID list in the existing subscriptions.
Parameters
- client: connection
- selectors: Selector[]
Returns Selector[]
- Defined in PubSub.ts:1428

`Private` updateClient

updateClient(curClient, curData, data): Promise<void>
Parameters
- curClient: connection
- curData: QuerySubscriptionData
- data: PublishEntityMessageData
Returns Promise<void>
- Defined in PubSub.ts:1137

`Static` initPublisher

initPublisher(config, nymph): void
Parameters
- config: Partial<Config>
- nymph: Nymph
Returns void
- Defined in PubSub.ts:76

`Private` `Static` isOrIsDescendant

isOrIsDescendant(parent, child): boolean
Parameters
- parent: Nymph
- child: Nymph
Returns boolean
- Defined in PubSub.ts:339

`Private` `Static` publish

publish(message, config): void
Parameters
- message: string
- config: Config
Returns void
- Defined in PubSub.ts:303

`Private` `Static` publishTransactionPublishes

publishTransactionPublishes(nymph): Promise<void>
Parameters
- nymph: Nymph
Returns Promise<void>
- Defined in PubSub.ts:350

`Private` `Static` removeTransactionPublishes

removeTransactionPublishes(nymph): void
Parameters
- nymph: Nymph
Returns void
- Defined in PubSub.ts:378

Class PubSub

Author

Copyright

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PubSub

Properties

config

nymph

Protected querySubs

Type declaration

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

[query: string]: Map<connection, QuerySubscriptionData>

server

Private sessions

Type declaration

authToken: string

Optional switchToken?: string

Protected uidSubs

Type declaration

[uidName: string]: Map<connection, { count: boolean; }>

Protected Static transactionPublishes

Type declaration

config: Config

nymph: Nymph

payload: string

Methods

close

Returns void

Private findQRefQueries

Parameters

Returns [MessageOptions, ...Selector[]][]

Private handleAuthentication

Parameters

Returns void

Private handlePublish

Parameters

Returns Promise<void>

Private handlePublishEntity

Parameters

Returns Promise<void>

Private handlePublishUid

Parameters

Returns Promise<void>

handleRequest

Parameters

Returns void

Private handleSubscription

Parameters

Returns Promise<void>

Private handleSubscriptionQuery

Parameters

etype: string

query: string

Returns Promise<void>

Private handleSubscriptionUid

Parameters

Returns Promise<void>

onClose

Parameters

Returns void

onError

Parameters

Returns void

onMessage

Parameters

Returns Promise<void>

Private relay

Parameters

Returns void

Private translateQRefSelectors

Parameters

Returns Selector[]

Private updateClient

`Protected` querySubs

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

`Private` sessions

`Optional` switchToken?: string

`Protected` uidSubs

[uidName: string]: Map<connection, {
count: boolean;
}>

`Protected` `Static` transactionPublishes

`Private` findQRefQueries

`Private` handleAuthentication

`Private` handlePublish

`Private` handlePublishEntity

`Private` handlePublishUid

`Private` handleSubscription

`Private` handleSubscriptionQuery

`Private` handleSubscriptionUid

`Private` relay

`Private` translateQRefSelectors

`Private` updateClient

`Static` initPublisher

`Private` `Static` isOrIsDescendant

`Private` `Static` publish

`Private` `Static` publishTransactionPublishes

`Private` `Static` removeTransactionPublishes