Class MotionMasterReqResWebSocket

Hierarchy

MotionMasterReqResWebSocket

Implements

MotionMasterReqResSocket

Index

Constructors

Constructors

constructor

new MotionMasterReqResWebSocket(): MotionMasterReqResWebSocket
Returns MotionMasterReqResWebSocket

Properties

`Private` `Optional` _pingSystemInterval

_pingSystemInterval?: number

`Private` `Optional` _systemAliveTimeout

_systemAliveTimeout?: number

`Private` `Optional` _url

_url?: string

`Readonly` alive$

alive$: BehaviorSubject<boolean> = ...

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

`Private` aliveTimeoutId

aliveTimeoutId: number = 0

`Readonly` close$

close$: Subject<{
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$: Subject<IMotionMasterMessage> = ...

Decoded message instances coming from Motion Master.

`Readonly` opened$

opened$: BehaviorSubject<boolean> = ...

Emits a boolean value when socket gets opened or closed.

`Private` pingSystemObserver

pingSystemObserver: {
next: (() => void);
} = ...

Type declaration

next: (() => void)
- - (): void
  - Returns void

`Private` `Optional` pingSystemSubscription

pingSystemSubscription?: Subscription

`Private` `Optional` webSocket$

webSocket$?: WebSocketSubject<Uint8Array>

Accessors

pingSystemInterval

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

Returns undefined | number
Implementation of MotionMasterReqResSocket.pingSystemInterval
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:33

systemAliveTimeout

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

Returns undefined | number
Implementation of MotionMasterReqResSocket.systemAliveTimeout
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:37

url

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

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

Methods

close

close(): void
Close socket.

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

Returns void
Implementation of MotionMasterReqResSocket.close
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:69

`Private` createWebSocket

createWebSocket(url: string, pingSystemInterval?: number): WebSocketSubject<Uint8Array>
Parameters
- url: string
- pingSystemInterval: number = 250
Returns WebSocketSubject<Uint8Array>
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:89

`Private` keepalive

keepalive(systemAliveTimeout?: number): void
Parameters
- systemAliveTimeout: number = 1000
Returns void
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:117

open

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

The connected$ and eventually alive$ observables will emit true values.
Parameters
- url: string
- pingSystemInterval: number = 250
- systemAliveTimeout: number = 1000
Returns void
Implementation of MotionMasterReqResSocket.open
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:41

reopen

reopen(): void
Reopen socket.

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

Returns void
Implementation of MotionMasterReqResSocket.reopen
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:73

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
Implementation of MotionMasterReqResSocket.send
- Defined in libs/motion-master-client/src/lib/motion-master-req-res-web-socket.ts:79

Class MotionMasterReqResWebSocket

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MotionMasterReqResWebSocket

Properties

Private Optional _pingSystemInterval

Private Optional _systemAliveTimeout

Private Optional _url

Readonly alive$

Private aliveTimeoutId

Readonly close$

Link

Readonly message$

Readonly opened$

Private pingSystemObserver

Type declaration

next: (() => void)

Returns void

Private Optional pingSystemSubscription

Private Optional webSocket$

Accessors

pingSystemInterval

Returns undefined | number

systemAliveTimeout

Returns undefined | number

url

Returns undefined | string

Methods

close

Returns void

Private createWebSocket

Parameters

url: string

pingSystemInterval: number = 250

Returns WebSocketSubject<Uint8Array>

Private keepalive

Parameters

systemAliveTimeout: number = 1000

Returns void

open

Parameters

url: string

pingSystemInterval: number = 250

systemAliveTimeout: number = 1000

Returns void

reopen

Returns void

send

Parameters

message: IMotionMasterMessage

Returns void

Settings

Member Visibility

Theme

`Private` `Optional` _pingSystemInterval

`Private` `Optional` _systemAliveTimeout

`Private` `Optional` _url

`Readonly` alive$

`Private` aliveTimeoutId

`Readonly` close$

`Readonly` message$

`Readonly` opened$

`Private` pingSystemObserver

`Private` `Optional` pingSystemSubscription

`Private` `Optional` webSocket$

`Private` createWebSocket

`Private` keepalive