Options
All
  • Public
  • Public/Protected
  • All
Menu

digital web socket Class also implements websocket client abstract methods

Hierarchy

Index

Constructors

Properties

auth: CXoneAuth = CXoneAuth.instance
heartBeatTimer: Timer = undefined
internetCheckTimer: Timer = undefined
logger: CcfLogger = ...
maxReconnectAttempt: number = 10
onMessageReceived: Subject<any> = ...

used to send emitted websocket events data.

onWebSocketConnectionStatus: Subject<any> = ...

used for sending websocket connection status like success, error etc.

pendingPong: number = PENDING_PONG_DEFAULT_VALUE
retryIntervalInMs: number = 6000
wssWorker: any
cxoneDigitalWebsocket: CXoneDigitalWebsocket

Accessors

Methods

  • attemptToReconnect(retryOptions?: { maxRetryAttempts: number; retryIntervalInMs: number }): void
  • Use to attempt to reconnect to the web socket worker

    example
    this.attemptToReconnect();
    

    Parameters

    • Optional retryOptions: { maxRetryAttempts: number; retryIntervalInMs: number }
      • maxRetryAttempts: number
      • retryIntervalInMs: number

    Returns void

  • broadcastWsData(msg: any): void
  • checkWssHeartBeat(heartBeatIntervalMilliSec: number): void
  • close(wsWorker?: any): void
  • connect(websocketUrl: string, wsWorker?: any): void
  • handleInternetDisruption(): void
  • initWebSocketWorker(): void
  • onClosed(): void
  • onError(): void
  • onMessage(msg: any): void
  • onOpen(): void
  • onReconnectComplete(): void
  • onReconnectSuccess(): void
  • registerDigitalWebSocket(): void
  • sendMessage(msg: unknown, wsWorker: any): void
  • startWebSocket(): void
  • terminateWebSocketWorker(): void

Generated using TypeDoc