teleop 0.3.0

Teleoperate Rust Processes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Teleop
[![Latest Version](https://img.shields.io/crates/v/teleop)](https://crates.io/crates/teleop)
[![Documentation](https://docs.rs/teleop/badge.svg)](https://docs.rs/teleop)
[![Build Status](https://github.com/arnodb/teleop/actions/workflows/ci.yml/badge.svg)](https://github.com/arnodb/teleop/actions/workflows/ci.yml)
[![Code Coverage](https://codecov.io/gh/arnodb/teleop/branch/main/graph/badge.svg)](https://codecov.io/gh/arnodb/teleop)

Teleop provides a means to attach to a local process knowing its ID, and then provides RPC capabilities to the client.

It currently only supports UNIX socket and Cap’n Proto RPC, but it is aimed at providing more ways to attach to a process and to communicate with it.

## UNIX socket

The implementation is very much inspired by Java [Attach API](https://docs.oracle.com/javase/8/docs/technotes/guides/attach/index.html):

* the process to be teleoperated waits for a signal
* if some conditions are met then it opens the UNIX socket at a known location
* the client can then connect to the unix socket and use the RPC protocol set up by the remote process

## Cap'n Proto RPC

Teleop provides a root interface named `Teleop` (see `teleop.capnp`) which gives access to arbitrary services.

## Example

* [server.rs](examples/server.rs) shows how to setup the process to teleoperate, including an `echo` service which will reply to a request by echoing the input.
* [client.rs](examples/client.rs) shows how to setup the client, initiate the attach process, request the `echo` service, and send echo requests.