@univerjs/rpc v0.5.0-beta.1 • Docs
@univerjs/rpc
Classes
| Class | Description |
|---|---|
| ChannelClient | This method provides implementation for IChannel and is responsible for transforming a local calling to a RPC calling. |
| ChannelServer | - |
| ChannelService | This service is responsible for managing the RPC channels. |
| DataSyncPrimaryController | This controller is responsible for syncing data from the primary thread to the worker thread. |
| DataSyncReplicaController | This controller is responsible for syncing data from the worker thread to the primary thread. |
| RemoteSyncPrimaryService | - |
| UniverRPCMainThreadPlugin | This plugin is used to register the RPC services on the main thread. It is also responsible for booting up the Web Worker instance of Univer. |
| UniverRPCWorkerThreadPlugin | This plugin is used to register the RPC services on the worker thread. |
| WebWorkerRemoteInstanceService | - |
Interfaces
| Interface | Description |
|---|---|
| IMessageProtocol | This protocol is for transferring data from the two peer univer instance running in different locations. |
| IRemoteInstanceService | - |
| IRemoteSyncService | - |
| IRPCChannelService | - |
| IUniverRPCMainThreadConfig | - |
| IUniverRPCWorkerThreadConfig | - |
Variables
| Variable | Description |
|---|---|
| RemoteInstanceServiceName | - |
| RemoteSyncServiceName | - |
Functions
| Function | Description |
|---|---|
| fromModule | Wrapper a service or a controller into a channel so it could be invoked by a remote client. When the protocol is called, it would forward to the underlying service or controller. |
| IRemoteInstanceService | This service is provided by the replica Univer. |
| IRemoteSyncService | This service is provided by the primary Univer. |
| IRPCChannelService | - |
| toModule | Wrap a channel into a service or a controller so it could be invoked by the upper layer modules. When the service or controller is called, it would request the remote server by calling the channel. |