EngineWebsocket | @acaengine/ts-client

Hierarchy

EngineWebsocket
- MockEngineWebsocket

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new EngineWebsocket(auth: EngineAuthService, options: EngineWebsocketOptions): EngineWebsocket

- Defined in websocket/websocket.class.ts:59
Parameters
- auth: EngineAuthService
- options: EngineWebsocketOptions
Returns EngineWebsocket

Properties

Protected _status

_status: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false)

BehaviorSubject holding the connection status of the websocket

Protected _status_obs

_status_obs: Observable<boolean> = this._status.asObservable()

Observable fo the connection status subject value

Protected auth

auth: EngineAuthService

Protected binding

binding: {}

Subjects for listening to values of bindings

Type declaration

[id: string]: BehaviorSubject<any>

debug_events

debug_events: Subject<EngineDebugEvent> = new Subject<EngineDebugEvent>()

Listener for debugging events

Protected keep_alive

keep_alive: number | undefined

Interval ID for the server ping callback

Protected observers

observers: {}

Observers for the binding subjects

Type declaration

[id: string]: Observable<any>

Protected options

options: EngineWebsocketOptions

Protected promise_callbacks

promise_callbacks: {}

Request responders

Type declaration

[id: string]: { reject: (_?: any) => void; resolve: (_?: any) => void }
- reject: (_?: any) => void
  - - (_?: any): void
    - Parameters
      - Optional _: any
      Returns void
- resolve: (_?: any) => void
  - - (_?: any): void
    - Parameters
      - Optional _: any
      Returns void

Protected requests

requests: {}

Request promises

Type declaration

[id: string]: EngineCommandRequestMetadata

Protected websocket

websocket: WebSocketSubject<any> | undefined

Websocket for connecting to engine

Accessors

is_connected

get is_connected(): boolean

- Defined in websocket/websocket.class.ts:73
Whether the websocket is connected

Returns boolean

route

get route(): string

- Defined in websocket/websocket.class.ts:66
Returns string

Methods

bind

bind(options: EngineRequestOptions): Promise<void>

- Defined in websocket/websocket.class.ts:114
Bind to status variable on the given system module

Parameters
- options: EngineRequestOptions
  
  Binding request options
Returns Promise<void>

Protected clearHealthCheck

clearHealthCheck(): void

- Defined in websocket/websocket.class.ts:414
Clear health check timer

Returns void

Protected connect

connect(tries?: number): void

- Defined in websocket/websocket.class.ts:297
Connect to engine websocket

Parameters
- Default value tries: number = 0
Returns void

Protected createWebsocket

createWebsocket(): void

- Defined in websocket/websocket.class.ts:347
Create websocket connection

Returns void

debug

debug(options: EngineRequestOptions): Promise<void>

- Defined in websocket/websocket.class.ts:141
Listen to debug logging for on the given system module binding

Parameters
- options: EngineRequestOptions
  
  Debug request options
Returns Promise<void>

exec

exec(options: EngineExecRequestOptions): Promise<any>

- Defined in websocket/websocket.class.ts:132
Execute method on the given system module

Parameters
- options: EngineExecRequestOptions
  
  Exec request options
Returns Promise<any>

Protected handleError

handleError(message: EngineResponse): void

- Defined in websocket/websocket.class.ts:234
Handle websocket request error

Parameters
- message: EngineResponse
  
  Error response
Returns void

Protected handleNotify

handleNotify<T>(options: EngineRequestOptions, value: T): void

- Defined in websocket/websocket.class.ts:279
Update the current value of the binding

Type parameters
- T
Parameters
- options: EngineRequestOptions
  
  Binding details
- value: T
  
  New binding value
Returns void

Protected handleSuccess

handleSuccess(message: EngineResponse): void

- Defined in websocket/websocket.class.ts:218
Handle websocket success response

Parameters
- message: EngineResponse
  
  Success message
Returns void

ignore

ignore(options: EngineRequestOptions): Promise<void>

- Defined in websocket/websocket.class.ts:150
Stop listen to debug logging for on the given system module binding

Parameters
- options: EngineRequestOptions
  
  Debug request options
Returns Promise<void>

listen

listen<T>(options: EngineRequestOptions, next: (value: T) => void): Subscription

- Defined in websocket/websocket.class.ts:89
Listen to binding changes on the given status variable

Type parameters
- T
Parameters
- options: EngineRequestOptions
  
  Binding details
- next: (value: T) => void
  
  Callback for value changes
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns Subscription

Protected onMessage

onMessage(message: EngineResponse | "pong"): void

- Defined in websocket/websocket.class.ts:191
Callback for messages from the server

Parameters
- message: EngineResponse | "pong"
  
  Message from the engine server
Returns void

Protected onWebSocketError

onWebSocketError(err: SimpleNetworkError): void

- Defined in websocket/websocket.class.ts:399
Handle errors on the websocket

Parameters
- err: SimpleNetworkError
  
  Network error response
Returns void

Protected ping

ping(): void

- Defined in websocket/websocket.class.ts:389
Send ping through the websocket

Returns void

Protected reconnect

reconnect(): void

- Defined in websocket/websocket.class.ts:373
Close old websocket connect and open a new one

Returns void

Protected send

send(request: EngineCommandRequest, tries?: number): Promise<any>

- Defined in websocket/websocket.class.ts:159
Send request to engine through the websocket connection

Parameters
- request: EngineCommandRequest
  
  New request to post to the server
- Default value tries: number = 0
Returns Promise<any>

status

status(next: (_: boolean) => void): Subscription

- Defined in websocket/websocket.class.ts:80
Listen to websocket status changes

Parameters
- next: (_: boolean) => void
  - - (_: boolean): void
    - Parameters
      - _: boolean
      Returns void
Returns Subscription

unbind

unbind(options: EngineRequestOptions): Promise<void>

- Defined in websocket/websocket.class.ts:123
Unbind from a status variable on the given system module

Parameters
- options: EngineRequestOptions
  
  Unbind request options
Returns Promise<void>

value

value<T>(options: EngineRequestOptions): T | undefined

- Defined in websocket/websocket.class.ts:103
Get current binding value

Type parameters
- T
Parameters
- options: EngineRequestOptions
  
  Binding details
Returns T | undefined

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

auth: EngineAuthService

options: EngineWebsocketOptions

Returns EngineWebsocket

Properties

Protected _status

Protected _status_obs

Protected auth

Protected binding

Type declaration

[id: string]: BehaviorSubject<any>

debug_events

Protected keep_alive

Protected observers

Type declaration

[id: string]: Observable<any>

Protected options

Protected promise_callbacks

Type declaration

[id: string]: { reject: (_?: any) => void; resolve: (_?: any) => void }

reject: (_?: any) => void

Parameters

Optional _: any

Returns void

resolve: (_?: any) => void

Parameters

Optional _: any

Returns void

Protected requests

Type declaration

[id: string]: EngineCommandRequestMetadata

Protected websocket

Accessors

is_connected

Returns boolean

route

Returns string

Methods

bind

Parameters

options: EngineRequestOptions

Returns Promise<void>

Protected clearHealthCheck

Returns void

Protected connect

Parameters

Default value tries: number = 0

Returns void

Protected createWebsocket

Returns void

debug

Parameters

options: EngineRequestOptions

Returns Promise<void>

exec

Parameters

options: EngineExecRequestOptions

Returns Promise<any>

Protected handleError

Parameters

message: EngineResponse

Returns void

Protected handleNotify

Type parameters

T

Parameters

options: EngineRequestOptions

value: T

Returns void

Protected handleSuccess

Parameters

message: EngineResponse