Class TobiClient

Index

Constructors

Methods

autoSend clearHandlers connect disconnect getHandlerCount isConnected registerHandler removeHandler send

Constructors

constructor

new TobiClient(url?, port?): common.tobi.TobiClient
Parameters
- url: string = 'localhost'
- port: number = 8002
Returns common.tobi.TobiClient
- Defined in packages/ts_common/src/tobi.ts:39

Methods

autoSend

autoSend(data): Promise<void>
Send a message, automatically connecting if needed Abstracts away connection logic
Parameters
- data: any
Returns Promise<void>
- Defined in packages/ts_common/src/tobi.ts:149

clearHandlers

clearHandlers(): void
Clear all handlers

Returns void
- Defined in packages/ts_common/src/tobi.ts:183

connect

connect(): Promise<void>
Connect to the WebSocket server

Returns Promise<void>
- Defined in packages/ts_common/src/tobi.ts:47

disconnect

disconnect(): void
Disconnect from the WebSocket server

Returns void
- Defined in packages/ts_common/src/tobi.ts:191

getHandlerCount

getHandlerCount(): number
Get the number of registered handlers

Returns number
- Defined in packages/ts_common/src/tobi.ts:210

isConnected

isConnected(): boolean
Check if connected

Returns boolean
- Defined in packages/ts_common/src/tobi.ts:203

registerHandler

registerHandler(handler): void
Register a message handler All registered handlers will be called when a message is received
Parameters
- handler: MessageHandler
Returns void
- Defined in packages/ts_common/src/tobi.ts:164

removeHandler

removeHandler(handler): void
Remove a specific handler
Parameters
- handler: MessageHandler
Returns void
- Defined in packages/ts_common/src/tobi.ts:172

send

send(data): void
Send a message to the WebSocket server
Parameters
- data: any
Returns void
- Defined in packages/ts_common/src/tobi.ts:135