Class LabGuiWebsocket

Hierarchy

  • LabGuiWebsocket

Constructors

constructor

Properties

forcedClose onclose onconnecting onerror onopen protocols readyState reconnectAttempts settings timedOut url ws

Accessors

connectionState wsInstance

Methods

close connect get_message_object log message_logic onmessage send

Constructors

constructor

Properties

Private forcedClose

forcedClose: boolean = false

onclose

onclose: ((event: Event) => void) = ...

Type declaration

    • (event: Event): void

    • Parameters

      • event: Event

      Returns void

onconnecting

onconnecting: (() => void) = ...

Type declaration

    • (): void

    • Returns void

onerror

onerror: ((event: Event) => void) = ...

Type declaration

    • (event: Event): void

    • Parameters

      • event: Event

      Returns void

onopen

onopen: ((event: Event) => void) = ...

Type declaration

    • (event: Event): void

    • Parameters

      • event: Event

      Returns void

Private protocols

protocols: string[]

Private readyState

readyState: number

Private reconnectAttempts

reconnectAttempts: number

settings

settings: LabGuiWebsocketSettings = ...

Private timedOut

timedOut: boolean = false

Private url

url: string

Private ws

ws: null | WebSocket = null

Accessors

connectionState

  • get connectionState(): number

  • Returns the current readyState and is only used for testing

    Returns number

wsInstance

  • get wsInstance(): null | WebSocket

  • Returns the used WebSocket instance and is only used for testing

    Returns null | WebSocket

Methods

close

  • Closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing. Returns boolean, whether websocket was FORCEFULLY closed.

    Returns boolean

connect

  • Connects the WebSocket to the Server at the given url. This method get automatically executed at instance creation, if automaticOpen=false is passes with the settings.

    Parameters

    • reconnectAttempt: boolean

    Returns void

get_message_object

  • Takes the response from the Server (which is expected to be a JSON sting) and return the object representation of that data.

    Parameters

    • response: MessageEvent<any>

    Returns object

Private log

  • Private logging method which only logs if the setting 'debug' is set to true

    Parameters

    • Rest ...args: any[]

    Returns void

message_logic

  • Dummy method which is supposed to be overwritten

    Parameters

    • msgObject: object

    Returns void

onmessage

  • Action to be triggered when the Server send data to the client. The sent data is expected to be a JSON sting. The object generated from that response is than passed to message_logic which is supposed to be overwritten and do all the business logic.

    Parameters

    • response: MessageEvent<any>

    Returns void

send

  • Transmits data to the server over the WebSocket connection.

    Parameters

    • data: string | SendData

      a text string or SendData to send to the server.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc