IpcSocket
Types for working with IpcInterfaces.
Classes
| Name |
Description |
|
| BackendIpc |
This class provides backend support for Ipc operations. |
Beta |
| FrontendIpc |
This class provides frontend support for Ipc operations. |
Beta |
| IpcHandler |
Base class for all implementations of an Ipc interface. |
Beta |
| ResponseHandler |
Base class for all implementations of an Ipc notification response interface. |
Beta |
Global Functions
| Name |
Description |
|
| iTwinChannel |
The prefix for all IpcSocket channels to disambiguate from system channels. |
Beta |
Interfaces
| Name |
Description |
|
| IpcSocket |
An inter-process socket connection between a single IModelHost on the backend (the node process), and an IModelApp on |
Beta |
| IpcSocketBackend |
Interface for the backend (Node.js) side of a socket connection. |
Beta |
| IpcSocketFrontend |
Interface for the frontend (browser) side of a socket connection. |
Beta |
Type Aliases
| Name |
Description |
|
| AsyncFunction |
type check for an function that returns a Promise |
Beta |
| AsyncMethodsOf |
a type that is the list of the asynchronous functions in an interface |
Beta |
| IpcListener |
A function to handle an Ipc message. |
Beta |
| PromiseReturnType |
get the type of the promised value of an asynchronous function |
Beta |
| RemoveFunction |
Function returned when establishing an Ipc receive listener or invoke handler. |
Beta |
Last Updated:
25 February, 2021