Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MPWebsocketWrapper

Hierarchy

  • MPWebsocketWrapper

Index

Constructors

Methods

Constructors

constructor

  • Parameters

    • url: any

    Returns MPWebsocketWrapper

Methods

clearSocket

  • clearSocket(): void

  • Returns void

connect

  • connect(): boolean

  • Returns boolean

getEstimatedPingMs

  • getEstimatedPingMs(): number

  • Returns the estimated ping in ms

    Returns number

internalAsyncSerialize

  • internalAsyncSerialize(packet: any): Promise<Object>

  • Parameters

    • packet: any

    Returns Promise<Object>

internalOnClose

  • internalOnClose(): void

  • Returns void

internalOnError

  • internalOnError(event: any): void

  • Parameters

    • event: any

    Returns void

internalOnMessage

  • internalOnMessage(event: any): void

  • Parameters

    • event: any

    Returns void

internalOnOpen

  • internalOnOpen(): void

  • Returns void

internalSend

  • internalSend(message: any): boolean

  • Parameters

    • message: any

    Returns boolean

internalSendKeepalive

  • internalSendKeepalive(event: any): void

  • Parameters

    • event: any

    Returns void

send

  • send(packet: any, forceSync?: boolean): false | true | Promise<false | true | void>

  • Sends a new packet

    Parameters

    • packet: any
    • Default value forceSync: boolean = false

      Whether to force the send out of the packet synchroneously

    Returns false | true | Promise<false | true | void>

shutdown

  • shutdown(): void

  • Shuts down the connection, forever

    Returns void

shutdownSignals

  • shutdownSignals(): void

  • Returns void