Class StpWebSocketsConnector

constructor

• new StpWebSocketsConnector(connstring): StpWebSocketsConnector

• Construct a connection object

  Parameters

  • connstring: string

    Websocket connection string - "ws://server.com:port"

  Returns StpWebSocketsConnector

Readonly DEFAULT_TIMEOUT

connstring

machineId

name

onError

onInform

onRequest

serviceName

sessionId

socket

solvables

timeout

connState

• get connState(): string

• Returns string

isConnected

• get isConnected(): boolean

• True if the connection is open and capable of sending and receiving messages

  Returns boolean

isConnecting

• get isConnecting(): boolean

• Returns boolean

connect

• connect(serviceName, solvables, timeout?, machineId?, sessionId?): Promise<undefined | string>

• Connect and register the service, informing of the subscriptions it handles / consumes

  Parameters

  • serviceName: string

    Name of the service that is connecting

  • solvables: string[]

    Array of messages that this service handles

  • timeout: number = ...

    Optional number of seconds to wait for a connection before failing

  • machineId: null | string = null

    Optional machine Id to use. If not provided, it is set to some unique Id.

  • sessionId: null | string = null

    Optional session Id to use. If not provided:

    1. the suffix to the WebSocket connection string is used
    2. if no WebSocket suffix was provided, the machineId is used
    3. If machineId is not provided, a unique random Id is used.

  Returns Promise<undefined | string>

  The actual sessionId used - the one provided here or a default set by STP

disconnect

• disconnect(timeout?): Promise<void>

• Disconnect from STP

  Parameters

  • timeout: number = ...

  Returns Promise<void>

inform

• inform(message, timeout?): Promise<void>

• Send a message/command to STP

  Parameters

  • message: string

    STP API message to send

  • timeout: number = ...

  Returns Promise<void>

request

• request(message, timeout?): Promise<any>

• Make a STP request - equivalent to an RPC call

  Parameters

  • message: string

    STP API message to send

  • timeout: number = ...

  Returns Promise<any>

  STP API responses