Class CometClient`Abstract`

Comet client interface. The is to allow for mocking the inner streaming Cometd implementation. The Faye implementation is used by default but it could be used to adapt another Cometd impl.

Hierarchy (view full)

EventEmitter
- CometClient
  - StreamingMockCometClient

Index

Constructors

Methods

addExtension disable disconnect handshake setHeader subscribe

Constructors

constructor

new CometClient(options?): CometClient
Parameters
- Optional options: EventEmitterOptions
Returns CometClient
Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:109

Methods

`Abstract` addExtension

addExtension(extension): void
Add a custom extension to the underlying client.
Parameters
- extension: StreamingExtension
  The json function for the extension.
Returns void
- Defined in src/status/types.ts:76

`Abstract` disable

disable(label): void
Disable polling features.
Parameters
- label: string
  Polling feature label.
Returns void
- Defined in src/status/types.ts:69

`Abstract` disconnect

disconnect(): void
Method to call to disconnect the client from the server.

Returns void
- Defined in src/status/types.ts:105

`Abstract` handshake

handshake(callback): void
handshake with the streaming channel
Parameters
- callback: (() => void)
  Callback for the handshake when it successfully completes. The handshake should throw errors when errors are encountered.
  - - (): void
    - Returns void
Returns void
- Defined in src/status/types.ts:92

`Abstract` setHeader

setHeader(name, value): void
Sets an http header name/value.
Parameters
- name: string
  The header name.
- value: string
  The header value.
Returns void
- Defined in src/status/types.ts:84

`Abstract` subscribe

subscribe(channel, callback): CometSubscription
Subscribes to Comet topics. Subscribe should perform a handshake if one hasn't been performed yet.
Parameters
- channel: string
  The topic to subscribe to.
- callback: ((message) => void)
  The callback to execute once a message has been received.
  - - (message): void
    - Parameters
      message: JsonMap
      Returns void
Returns CometSubscription
- Defined in src/status/types.ts:100