Class SignalingClient

Like an EventEmitter, instances of this class allow us register and unregister listeners for events, but it allows listening for those messages that match a pattern.

Example

let x = new Emitter();
  x.addContentListener({foo: 'bar'}, (data) => {
    console.log('received data', data);
  });
  x.emit({foo: 'bar', hello: 'world'})

  > received data {foo: 'bar', hello: 'world'}

Hierarchy

Constructors

constructor

Properties

address callTransfer dependencies invites pending pendingWithInviteId pingTimer register rooms socket

Accessors

ready

Methods

addContentListener cleanPendingWithIdIfExists cleanState closeCurrentSocket closePendingMessages emit handlerErrorSocket heartbeat init onClose onMessage reconnect removeContentListener send stopCurrentSocketAndReconnect unbindSocketEvents uninit waitPendingWithInviteId waitPendingWithRequestId

Constructors

constructor

Properties

Private address

address: string

callTransfer

callTransfer: CallTransferAPI

Private dependencies

dependencies: Dependencies = {}

invites

invites: InvitesAPI

Private pending

pending: Record<string, PendingRequest> = {}

Private pendingWithInviteId

pendingWithInviteId: Map<any, any> = ...

Private pingTimer

pingTimer: number = 0

register

register: RegisterAPI

rooms

rooms: RoomsAPI

Private socket

socket: null | default = null

Accessors

ready

Methods

addContentListener

  • Add an event listener that will be called when an event that matches provided filter is received

    Parameters

    • filter: {
          cancel?: string;
          payload?: any;
          request?: string;
      }

      filter that should match emited events to call provided function

      • Optional cancel?: string
      • Optional payload?: any
      • Optional request?: string
    • fn: ((...args: string[]) => void)

      callback to invoke on each new match.

        • (...args: string[]): void

        • Parameters

          • Rest ...args: string[]

          Returns void

    Returns void

cleanPendingWithIdIfExists

cleanState

closeCurrentSocket

closePendingMessages

emit

handlerErrorSocket

heartbeat

init

Private onClose

onMessage

reconnect

removeContentListener

  • Stop receiving events on a previously added listener.

    Parameters

    • fn: ((...args: string[]) => void)

      callback to remove from listeners list.

        • (...args: string[]): void

        • Parameters

          • Rest ...args: string[]

          Returns void

    Returns void

send

stopCurrentSocketAndReconnect

unbindSocketEvents

uninit

waitPendingWithInviteId

waitPendingWithRequestId

Settings

Member Visibility

Theme

Generated using TypeDoc