Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebSocket

Hierarchy

  • WebSocketBase
    • WebSocket

Implements

  • IWebSocket

Index

Constructors

Properties

Methods

Constructors

constructor

  • new WebSocket(requestUrl: string, protocol?: string): WebSocket

  • Parameters

    • requestUrl: string
    • Optional protocol: string

    Returns WebSocket

Properties

Private _aborting

_aborting: boolean

Private _closing

_closing: boolean

Private _onRequestCreated

_onRequestCreated: IAction1<HttpRequestCreatedArgs>

Private _onResponseReceived

_onResponseReceived: IAction1<HttpResponseReceivedArgs>

Private _openArgs

_openArgs: WebSocketOpenArgs

Private _opening

_opening: boolean

Private _protocol

_protocol: string

Private _raisedOpenFailure

_raisedOpenFailure: boolean

Private _raisedStreamFailure

_raisedStreamFailure: boolean

Private _requestUrl

_requestUrl: string

Private _sendArgs

_sendArgs: WebSocketSendArgs

Private _timer

_timer: number

Private _webSocket

_webSocket: any

Static Private _disableBinary

_disableBinary: boolean = false

Methods

close

  • close(): void
  • close(args: WebSocketCloseArgs): void

  • Returns void

  • Parameters

    • args: WebSocketCloseArgs

    Returns void

getBufferedAmount

  • getBufferedAmount(): number

  • Returns number

getIsOpen

  • getIsOpen(): boolean

  • Returns boolean

getSecure

  • getSecure(): boolean

  • Returns boolean

getTypeString

  • getTypeString(): string

  • Returns string

Private onClose

  • onClose(e: CloseEvent): any

  • Parameters

    • e: CloseEvent

    Returns any

Private onError

  • onError(e: Event): any

  • Parameters

    • e: Event

    Returns any

Private onMessage

  • onMessage(e: MessageEvent): any

  • Parameters

    • e: MessageEvent

    Returns any

Private onOpen

  • onOpen(e: Event): any

  • Parameters

    • e: Event

    Returns any

open

  • open(args: WebSocketOpenArgs): void

  • Parameters

    • args: WebSocketOpenArgs

    Returns void

Private processOnClose

  • processOnClose(code: number, reason: string): void

  • Parameters

    • code: number
    • reason: string

    Returns void

Protected raiseCloseComplete

  • raiseCloseComplete(closeArgs: WebSocketCloseArgs, statusCode: WebSocketStatusCode, reason: string): void
  • Raises the close complete callback.

    Parameters

    • closeArgs: WebSocketCloseArgs

      The close arguments.

    • statusCode: WebSocketStatusCode

      The status code.

    • reason: string

      The reason.

    Returns void

Private raiseOnRequestCreated

  • raiseOnRequestCreated(): void

  • Returns void

Private raiseOnResponseReceived

  • raiseOnResponseReceived(): void

  • Returns void

Protected raiseOpenFailure

  • raiseOpenFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void
  • Raises the open failure callback.

    Parameters

    • openArgs: WebSocketOpenArgs

      The open arguments.

    • statusCode: WebSocketStatusCode

      The status code.

    • exception: Exception

      The exception.

    Returns void

Protected raiseOpenSuccess

  • raiseOpenSuccess(openArgs: WebSocketOpenArgs): void
  • Raises the open success callback.

    Parameters

    • openArgs: WebSocketOpenArgs

      The open arguments.

    Returns void

Protected raiseReceive

  • raiseReceive(openArgs: WebSocketOpenArgs, textMessage: string, binaryMessage: Uint8Array): void
  • Raises the receive callback.

    Parameters

    • openArgs: WebSocketOpenArgs

      The open arguments.

    • textMessage: string

      The text message.

    • binaryMessage: Uint8Array

      The binary message.

    Returns void

Protected raiseStreamFailure

  • raiseStreamFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void
  • Raises the stream failure callback.

    Parameters

    • openArgs: WebSocketOpenArgs

      The open arguments.

    • statusCode: WebSocketStatusCode

      The status code.

    • exception: Exception

      The exception.

    Returns void

send

  • send(args: WebSocketSendArgs): void

  • Parameters

    • args: WebSocketSendArgs

    Returns void

Static getDisableBinary

  • getDisableBinary(): boolean

  • Returns boolean

Static getExists

  • getExists(): boolean

  • Returns boolean

Static setDisableBinary

  • setDisableBinary(disableBinary: boolean): void

  • Parameters

    • disableBinary: boolean

    Returns void