Interface MotionMasterReqResSocket

Hierarchy

MotionMasterReqResSocket

Implemented by

Index

Properties

alive$ close$ message$ opened$

Accessors

pingSystemInterval systemAliveTimeout url

Methods

close open reopen send

Properties

`Readonly` alive$

alive$: BehaviorSubject<boolean>

Motion Master is considered alive when it sends messages in regular time interval.

`Readonly` close$

close$: Observable<{
code: number;
reason: string;
}>

Emits close events with code and reason data.

Link

https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close_event

`Readonly` message$

message$: Observable<IMotionMasterMessage>

Decoded message instances coming from Motion Master.

`Readonly` opened$

opened$: BehaviorSubject<boolean>

Emits a boolean value when socket gets opened or closed.

Accessors

pingSystemInterval

get pingSystemInterval(): undefined | number
Send ping system messages to Motion Master with a fixed time delay between each call.

Returns undefined | number
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:34

systemAliveTimeout

get systemAliveTimeout(): undefined | number
How long in milliseconds to consider Motion Master alive.

Returns undefined | number
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:39

url

get url(): undefined | string
URL set in call to open.

Returns undefined | string
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:29

Methods

close

close(): void
Close socket.

The opened$ and alive$ observables will emit false values.

Returns void
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:53

open

open(url: string, pingSystemInterval?: number, systemAliveTimeout?: number): void
Open socket.

The connected$ and eventually alive$ observables will emit true values.
Parameters
- url: string
- Optional pingSystemInterval: number
- Optional systemAliveTimeout: number
Returns void
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:46

reopen

reopen(): void
Reopen socket.

Reopen if closed using the same url, pingSystemInterval, and systemAliveTimeout previously set in open.

Returns void
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:60

send

send(message: IMotionMasterMessage): void
Send an instance of a message.

Subscribe to the message$ observable in order to receive the response messages.
Parameters
- message: IMotionMasterMessage
Returns void
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-socket.ts:67

Generated using TypeDoc