Crate multilink

source ·
Expand description

multilink is an IPC library that allows communication via two methods:

  • Local processes/stdio: JSON-RPC messages are passed between parent/child process via stdin/stdout
  • Remote processes/HTTP: HTTP requests/responses are passed between processes on remote hosts

Utilizes tower to handle RPC calls.

Moving parts

Here are the moving parts of a solution that uses multilink:

  1. One set of protocol-agnostic request and response types: types that are used in all services, regardless of the underlying protocol; usually a set of enums
  2. The handling services: processes the protocol-agnostic requests, performs some logic and returns responses
  3. Conversion trait implementations: converts the protocol-agnostic requests/responses into JSON-RPC or HTTP request/responses
  4. HTTP and “JSON-RPC over stdio” clients and servers: the only part implemented by multilink; brings the three items above together

The caller of a multilink client will only use the protocol-agnostic request and response types, which allows seamless switching between protocols.

Re-exports

Modules

  • error
    Protocol error types.
  • http
    HTTP server and client.
  • jsonrpc
    JSON-RPC types and methods.
  • stdio
    JSON-RPC over stdio server and client.
  • util
    Miscellaneous utility functions.

Enums

Constants

Traits

  • ConfigExampleSnippet
    A configuration data structure that provides an example for generating new TOML configuration files. The example should include customizable fields with comments explaining their purpose.

Type Definitions