Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebSocketTransfer

Base class that defines methods for transferring content over the WebSocket protocol.

Hierarchy

  • WebSocketTransfer

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.webSocketTransfer class.

    Parameters

    • url: string

      The URL.

    Returns WebSocketTransfer

Properties

Private __url

__url: string
internal

Private _handshakeTimeout

_handshakeTimeout: number
internal

Private _onOpenFailure

_onOpenFailure: IAction1<WebSocketOpenFailureArgs>
internal

Private _onOpenSuccess

_onOpenSuccess: IAction1<WebSocketOpenSuccessArgs>
internal

Private _onRequestCreated

_onRequestCreated: IAction1<HttpRequestCreatedArgs>
internal

Private _onResponseReceived

_onResponseReceived: IAction1<HttpResponseReceivedArgs>
internal

Private _onStreamFailure

_onStreamFailure: IAction1<WebSocketStreamFailureArgs>
internal

Private _sender

_sender: Object
internal

Private _streamTimeout

_streamTimeout: number
internal

Methods

getHandshakeTimeout

  • getHandshakeTimeout(): number
  • Gets the timeout for the initial handshake (in ms).

    Returns number

getOnOpenFailure

  • getOnOpenFailure(): IAction1<WebSocketOpenFailureArgs>
  • Gets the callback to invoke if the handshake fails.

    Returns IAction1<WebSocketOpenFailureArgs>

getOnOpenSuccess

  • getOnOpenSuccess(): IAction1<WebSocketOpenSuccessArgs>
  • Gets the callback to invoke if the handshake succeeds.

    Returns IAction1<WebSocketOpenSuccessArgs>

getOnRequestCreated

  • getOnRequestCreated(): IAction1<HttpRequestCreatedArgs>
  • Gets the callback to invoke when the handshake request is created.

    Returns IAction1<HttpRequestCreatedArgs>

getOnResponseReceived

  • getOnResponseReceived(): IAction1<HttpResponseReceivedArgs>
  • Gets the callback to invoke when the handshake response is received.

    Returns IAction1<HttpResponseReceivedArgs>

getOnStreamFailure

  • getOnStreamFailure(): IAction1<WebSocketStreamFailureArgs>
  • Gets the callback to invoke if the stream errors out.

    Returns IAction1<WebSocketStreamFailureArgs>

getSender

  • getSender(): Object
  • Gets the sender of the messages.

    Returns Object

getStreamTimeout

  • getStreamTimeout(): number
  • Gets the timeout for the stream (in ms).

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getUrl

  • getUrl(): string
  • Gets the URL.

    Returns string

Abstract open

  • open(headers: NameValueCollection): void
  • Opens the socket.

    Parameters

    • headers: NameValueCollection

      The headers to pass in with the initial handshake.

    Returns void

Abstract send

  • send(requestArgs: HttpRequestArgs): HttpResponseArgs
  • Sends a request synchronously.

    Parameters

    • requestArgs: HttpRequestArgs

      The request parameters.

    Returns HttpResponseArgs

    The response parameters.

Abstract sendAsync

  • sendAsync(requestArgs: HttpRequestArgs, callback: IAction1<HttpResponseArgs>): void
  • Sends a request asynchronously.

    Parameters

    • requestArgs: HttpRequestArgs

      The request parameters.

    • callback: IAction1<HttpResponseArgs>

      The callback to execute with the resulting response.

    Returns void

setHandshakeTimeout

  • setHandshakeTimeout(value: number): void
  • Sets the timeout for the initial handshake (in ms).

    Parameters

    • value: number

    Returns void

setOnOpenFailure

  • setOnOpenFailure(value: IAction1<WebSocketOpenFailureArgs>): void
  • Sets the callback to invoke if the handshake fails.

    Parameters

    • value: IAction1<WebSocketOpenFailureArgs>

    Returns void

setOnOpenSuccess

  • setOnOpenSuccess(value: IAction1<WebSocketOpenSuccessArgs>): void
  • Sets the callback to invoke if the handshake succeeds.

    Parameters

    • value: IAction1<WebSocketOpenSuccessArgs>

    Returns void

setOnRequestCreated

  • setOnRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void
  • Sets the callback to invoke when the handshake request is created.

    Parameters

    • value: IAction1<HttpRequestCreatedArgs>

    Returns void

setOnResponseReceived

  • setOnResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void
  • Sets the callback to invoke when the handshake response is received.

    Parameters

    • value: IAction1<HttpResponseReceivedArgs>

    Returns void

setOnStreamFailure

  • setOnStreamFailure(value: IAction1<WebSocketStreamFailureArgs>): void
  • Sets the callback to invoke if the stream errors out.

    Parameters

    • value: IAction1<WebSocketStreamFailureArgs>

    Returns void

setSender

  • setSender(value: Object): void
  • Sets the sender of the messages.

    Parameters

    • value: Object

    Returns void

setStreamTimeout

  • setStreamTimeout(value: number): void
  • Sets the timeout for the stream (in ms).

    Parameters

    • value: number

    Returns void

setUrl

  • setUrl(value: string): void
  • Sets the URL.

    Parameters

    • value: string

    Returns void

Abstract shutdown

  • shutdown(): void
  • Releases any resources and shuts down.

    Returns void