Class WorkerCommunicationChannel

Communication implementation for workers in PSX

This class is an internal implementation detail used by higher-level contribution APIs.

Hierarchy (View Summary)

CommunicationChannel
- WorkerCommunicationChannel

Index

Constructors

Properties

id messageChannel portToMainThread worker

Methods

handleMessage request requestInternal requestObserve requestObserveInternal unsubscribeFinalized

Constructors

constructor

new WorkerCommunicationChannel(
worker: WorkerScopeInterface,
): WorkerCommunicationChannel
Parameters
- worker: WorkerScopeInterface
Returns WorkerCommunicationChannel
Overrides CommunicationChannel.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:91

Properties

id

id: string

messageChannel

messageChannel: MessageChannel

portToMainThread

portToMainThread: MessagePort

`Readonly`worker

worker: WorkerScopeInterface

Methods

`Protected`handleMessage

handleMessage(event: MessageEvent): void
Parameters
- event: MessageEvent
Returns void
Inherited from CommunicationChannel.handleMessage
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:64

request

request<T>(type: string, data?: any): Promise<T>
Type Parameters
- T
Parameters
- type: string
- Optionaldata: any
Returns Promise<T>
Overrides CommunicationChannel.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:95

`Protected`requestInternal

requestInternal<T>(
    sender: any,
    type: string,
    name: string | undefined,
    data: any,
): Promise<T>
Type Parameters
- T
Parameters
- sender: any
- type: string
- name: string | undefined
- data: any
Returns Promise<T>
Inherited from CommunicationChannel.requestInternal
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:68

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Overrides CommunicationChannel.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:106

`Protected`requestObserveInternal

requestObserveInternal<T>(sender: any, type: string, data: any): Observable<T>
Type Parameters
- T
Parameters
- sender: any
- type: string
- data: any
Returns Observable<T>
Inherited from CommunicationChannel.requestObserveInternal
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:72

`Protected`unsubscribeFinalized

unsubscribeFinalized(id: string, sender: any): void
Parameters
- id: string
- sender: any
Returns void
Inherited from CommunicationChannel.unsubscribeFinalized
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:76