Class MotionMasterPubSubWebSocket

Hierarchy

MotionMasterPubSubWebSocket

Implements

MotionMasterPubSubSocket

Index

Constructors

Properties

_url? close$ data$ opened$ webSocket$?

Accessors

Methods

close createWebSocket open reopen

Constructors

constructor

new MotionMasterPubSubWebSocket(): MotionMasterPubSubWebSocket
Returns MotionMasterPubSubWebSocket

Properties

`Private` `Optional` _url

_url?: string

`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` data$

data$: Subject<[string, IMotionMasterMessage]> = ...

Incoming data is a tuple of topic and decoded message.

`Readonly` opened$

opened$: BehaviorSubject<boolean> = ...

Emits a boolean value when socket gets opened or closed.

`Private` `Optional` webSocket$

webSocket$?: WebSocketSubject<[string, IMotionMasterMessage]>

Accessors

url

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

Returns undefined | string
Implementation of MotionMasterPubSubSocket.url
- Defined in libs/motion-master-client/src/lib/motion-master-pub-sub-web-socket.ts:19

Methods

close

close(): void
Close socket.

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

Returns void
Implementation of MotionMasterPubSubSocket.close
- Defined in libs/motion-master-client/src/lib/motion-master-pub-sub-web-socket.ts:37

`Private` createWebSocket

createWebSocket(url: string): WebSocketSubject<[string, IMotionMasterMessage]>
Parameters
- url: string
Returns WebSocketSubject<[string, IMotionMasterMessage]>
- Defined in libs/motion-master-client/src/lib/motion-master-pub-sub-web-socket.ts:47

open

open(url: string): void
Open socket.

The connected$ and eventually alive$ observables will emit true values.
Parameters
- url: string
Returns void
Implementation of MotionMasterPubSubSocket.open
- Defined in libs/motion-master-client/src/lib/motion-master-pub-sub-web-socket.ts:23

reopen

reopen(): void
Reopen socket.

Reopen if closed using the same url previously set in open.

Returns void
Implementation of MotionMasterPubSubSocket.reopen
- Defined in libs/motion-master-client/src/lib/motion-master-pub-sub-web-socket.ts:41

Generated using TypeDoc