Class Connection

Implements

IRTCMetricsSender

Index

Constructors

Properties

connected connectionTimeout logger onBinaryData onClose onError onMessage pingChecker ws

Methods

close connect resetPingChecker send sendBatch sendBinaryData sendDescription stopPingChecking

Constructors

constructor

new Connection(onMessage, onBinaryData, onError, onClose, logger?): Connection
Parameters
- onMessage: OnMessageCallback
- onBinaryData: OnBinaryDataCallback
- onError: Function
- onClose: Function
- Optional logger: default
Returns Connection
- Defined in connection.ts:101

Properties

`Private` connected

connected: boolean

`Private` connectionTimeout

connectionTimeout: number

`Private` logger

logger: default

`Private` onBinaryData

onBinaryData: OnBinaryDataCallback

`Private` onClose

onClose: Function

`Private` onError

onError: Function

`Private` onMessage

onMessage: OnMessageCallback

`Private` pingChecker

pingChecker: WSPingReceiver

`Private` ws

ws: WebSocket

Methods

close

close(error?): Promise<void>
Parameters
- Optional error: ConnectionFailedEvent
Returns Promise<void>
- Defined in connection.ts:253

connect

connect(options): Promise<InitialUserData>
Parameters
- options: {
      appName: string;
      authToken?: string;
      custom: object;
      failedProbesThreshold?: number;
      pingInterval?: number;
      timeout?: number;
      url: string;
  }
  - appName: string
  - Optional authToken?: string
  - custom: object
  - Optional failedProbesThreshold?: number
  - Optional pingInterval?: number
  - Optional timeout?: number
  - url: string
Returns Promise<InitialUserData>
- Defined in connection.ts:137

`Private` resetPingChecker

resetPingChecker(eventName): void
Parameters
- eventName: string
Returns void
- Defined in connection.ts:284

send

send(message, data): void
Parameters
- message: string
- data: any
Returns void
- Defined in connection.ts:235

sendBatch

sendBatch(message): Promise<number>
Parameters
- message: RTCMetricsBatchMessage
Returns Promise<number>
Implementation of IRTCMetricsSender.sendBatch
- Defined in connection.ts:126

sendBinaryData

sendBinaryData(data): void
Parameters
- data: any
Returns void
- Defined in connection.ts:245

sendDescription

sendDescription(message): Promise<number>
Parameters
- message: RTCMetricsClientDescriptionMessage
Returns Promise<number>
Implementation of IRTCMetricsSender.sendDescription
- Defined in connection.ts:115

`Private` stopPingChecking

stopPingChecking(): void
Returns void
- Defined in connection.ts:277