Search Results for

    / fm / liveswitch / WebSocketBase

    Class: WebSocketBase

    fm.liveswitch.WebSocketBase

    WebSocket base properties/methods.

    Hierarchy

    • WebSocketBase

      ↳ WebSocket

    Table of contents

    Constructors

    • constructor

    Methods

    • getTypeString
    • raiseCloseComplete
    • raiseOpenFailure
    • raiseOpenSuccess
    • raiseReceive
    • raiseStreamFailure

    Constructors

    constructor

    + new WebSocketBase(): WebSocketBase

    Returns: WebSocketBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:13

    Methods

    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:9


    raiseCloseComplete

    ▸ ProtectedraiseCloseComplete(closeArgs: WebSocketCloseArgs, statusCode: WebSocketStatusCode, reason: string): void

    Raises the close complete callback.

    Parameters:

    Name Type Description
    closeArgs WebSocketCloseArgs The close arguments.
    statusCode WebSocketStatusCode The status code.
    reason string The reason.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:35


    raiseOpenFailure

    ▸ ProtectedraiseOpenFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

    Raises the open failure callback.

    Parameters:

    Name Type Description
    openArgs WebSocketOpenArgs The open arguments.
    statusCode WebSocketStatusCode The status code.
    exception Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:56


    raiseOpenSuccess

    ▸ ProtectedraiseOpenSuccess(openArgs: WebSocketOpenArgs): void

    Raises the open success callback.

    Parameters:

    Name Type Description
    openArgs WebSocketOpenArgs The open arguments.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:75


    raiseReceive

    ▸ ProtectedraiseReceive(openArgs: WebSocketOpenArgs, textMessage: string, binaryMessage: Uint8Array): void

    Raises the receive callback.

    Parameters:

    Name Type Description
    openArgs WebSocketOpenArgs The open arguments.
    textMessage string The text message.
    binaryMessage Uint8Array The binary message.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:94


    raiseStreamFailure

    ▸ ProtectedraiseStreamFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

    Raises the stream failure callback.

    Parameters:

    Name Type Description
    openArgs WebSocketOpenArgs The open arguments.
    statusCode WebSocketStatusCode The status code.
    exception Exception The exception.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:115

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6