Globals / "src/renderer/api/websocket-api" / WebSocketApi
Class: WebSocketApi#
Hierarchy#
- WebSocketApi
Index#
Constructors#
Properties#
Accessors#
Methods#
- _onClose
- _onError
- _onMessage
- _onOpen
- connect
- destroy
- flush
- parseMessage
- ping
- reconnect
- removeAllListeners
- send
- setParams
- writeLog
Object literals#
Constructors#
constructor#
+ new WebSocketApi(params: IParams): WebSocketApi
Defined in src/renderer/api/websocket-api.ts:45
Parameters:
| Name | Type |
|---|---|
params |
IParams |
Returns: WebSocketApi
Properties#
onClose#
• onClose: EventEmitter\<[]> = new EventEmitter\<[]>()
Defined in src/renderer/api/websocket-api.ts:37
onData#
• onData: EventEmitter\<[string]> = new EventEmitter\<[string]>()
Defined in src/renderer/api/websocket-api.ts:36
onOpen#
• onOpen: EventEmitter\<[]> = new EventEmitter\<[]>()
Defined in src/renderer/api/websocket-api.ts:35
params#
• Protected params: IParams
Defined in src/renderer/api/websocket-api.ts:47
pendingCommands#
• Protected pendingCommands: IMessage[] = []
Defined in src/renderer/api/websocket-api.ts:28
pingMessage#
• Protected pingMessage: string = "PING"
Defined in src/renderer/api/websocket-api.ts:31
pingTimer#
• Protected pingTimer: any
Defined in src/renderer/api/websocket-api.ts:30
readyState#
• readyState: WebSocketApiState = WebSocketApiState.PENDING
Defined in src/renderer/api/websocket-api.ts:33
reconnectTimer#
• Protected reconnectTimer: any
Defined in src/renderer/api/websocket-api.ts:29
socket#
• Protected socket: WebSocket
Defined in src/renderer/api/websocket-api.ts:27
Accessors#
isConnected#
• get isConnected(): boolean
Defined in src/renderer/api/websocket-api.ts:58
Returns: boolean
isOnline#
• get isOnline(): boolean
Defined in src/renderer/api/websocket-api.ts:63
Returns: boolean
Methods#
_onClose#
▸ Protected_onClose(evt: CloseEvent): void
Defined in src/renderer/api/websocket-api.ts:152
Parameters:
| Name | Type |
|---|---|
evt |
CloseEvent |
Returns: void
_onError#
▸ Protected_onError(evt: Event): void
Defined in src/renderer/api/websocket-api.ts:148
Parameters:
| Name | Type |
|---|---|
evt |
Event |
Returns: void
_onMessage#
▸ Protected_onMessage(evt: MessageEvent): void
Defined in src/renderer/api/websocket-api.ts:142
Parameters:
| Name | Type |
|---|---|
evt |
MessageEvent |
Returns: void
_onOpen#
▸ Protected_onOpen(evt: Event): void
Defined in src/renderer/api/websocket-api.ts:135
Parameters:
| Name | Type |
|---|---|
evt |
Event |
Returns: void
connect#
▸ connect(url?: string): void
Defined in src/renderer/api/websocket-api.ts:71
Parameters:
| Name | Type | Default value |
|---|---|---|
url |
string | this.params.url |
Returns: void
destroy#
▸ destroy(): void
Defined in src/renderer/api/websocket-api.ts:96
Returns: void
flush#
▸ Protectedflush(): void
Defined in src/renderer/api/websocket-api.ts:126
Returns: void
parseMessage#
▸ ProtectedparseMessage(data: string): string
Defined in src/renderer/api/websocket-api.ts:131
Parameters:
| Name | Type |
|---|---|
data |
string |
Returns: string
ping#
▸ ping(): void
Defined in src/renderer/api/websocket-api.ts:83
Returns: void
reconnect#
▸ reconnect(): void
Defined in src/renderer/api/websocket-api.ts:88
Returns: void
removeAllListeners#
▸ removeAllListeners(): void
Defined in src/renderer/api/websocket-api.ts:107
Returns: void
send#
▸ send(command: string): void
Defined in src/renderer/api/websocket-api.ts:113
Parameters:
| Name | Type |
|---|---|
command |
string |
Returns: void
setParams#
▸ setParams(params: Partial\<IParams>): void
Defined in src/renderer/api/websocket-api.ts:67
Parameters:
| Name | Type |
|---|---|
params |
Partial\<IParams> |
Returns: void
writeLog#
▸ ProtectedwriteLog(...data: any[]): void
Defined in src/renderer/api/websocket-api.ts:164
Parameters:
| Name | Type |
|---|---|
...data |
any[] |
Returns: void
Object literals#
defaultParams#
▪ Static defaultParams: object
Defined in src/renderer/api/websocket-api.ts:39
Properties:
| Name | Type | Value |
|---|---|---|
autoConnect |
true | true |
flushOnOpen |
true | true |
logging |
false | false |
pingIntervalSeconds |
number | 0 |
reconnectDelaySeconds |
number | 10 |