WebSocketService
Stock Screening Platform - Frontend API v0.1.0
Stock Screening Platform - Frontend API / services/websocketService / WebSocketService
Class: WebSocketService
Defined in: src/services/websocketService.ts:125
WebSocket Service Class
Manages WebSocket connection lifecycle and subscriptions
Constructors
Constructor
new WebSocketService(
config):WebSocketService
Defined in: src/services/websocketService.ts:137
Parameters
config
WSServiceConfig
Returns
WebSocketService
Methods
connect()
connect():
void
Defined in: src/services/websocketService.ts:151
Connect to WebSocket server
Returns
void
disconnect()
disconnect():
void
Defined in: src/services/websocketService.ts:185
Disconnect from WebSocket server
Returns
void
subscribe()
subscribe(
type,identifier):void
Defined in: src/services/websocketService.ts:201
Subscribe to stock updates
Parameters
type
identifier
string
Returns
void
unsubscribe()
unsubscribe(
type,identifier):void
Defined in: src/services/websocketService.ts:223
Unsubscribe from stock updates
Parameters
type
identifier
string
Returns
void
onMessage()
onMessage(
handler): () =>void
Defined in: src/services/websocketService.ts:245
Add message handler
Parameters
handler
MessageHandler
Returns
():
void
Returns
void
onStateChange()
onStateChange(
handler): () =>void
Defined in: src/services/websocketService.ts:257
Add state change handler
Parameters
handler
StateChangeHandler
Returns
():
void
Returns
void
getState()
getState():
WSConnectionState
Defined in: src/services/websocketService.ts:269
Get current connection state
Returns
isConnected()
isConnected():
boolean
Defined in: src/services/websocketService.ts:276
Check if connected
Returns
boolean