Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConvergenceOptions

Hierarchy

  • IConvergenceOptions

Index

Properties

Optional connectionTimeout

connectionTimeout: number

The maximum time to wait in ms for a successful connection to be made.

Optional maxReconnectAttempts

maxReconnectAttempts: number

The maximum number of times to reconnect, after which the connection will fail.

Optional reconnectInterval

reconnectInterval: number

The time to wait between connection attempts.

Optional retryOnOpen

retryOnOpen: boolean

Whether to attempt to reconnect when first connecting.

default

true

Optional webSocketClass

webSocketClass: IWebSocketClass

Optional webSocketFactory

webSocketFactory: WebSocketFactory

Defines the class / constructor that should be used to create WebSocket objects. This is useful when operating in NodeJS where a library like ws or isomorphic-ws can be used to provide a client side WebSocket API.