acktor-ipc 1.1.2

Interprocess communication support for the acktor actor framework
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# acktor-ipc

Interprocess communication for the [`acktor`](https://github.com/asymmetry/acktor) actor framework.

## About

`acktor-ipc` lets actors in different processes talk to each other over a transport of your choice. It introduces a `Node` actor that owns one or more listeners and per-connection `Session` actors that mediate traffic.

## Installation

```toml
[dependencies]
acktor-ipc = "1.0"
```

`acktor-ipc` already depends on `acktor` with the `ipc` feature enabled.

## Concepts

- **Node** — a long-lived actor that holds the listener(s) for inbound connections, tracks the
  active sessions, and owns the registry of remote-addressable / remote-spawnable actor types.
  Send `Connect<C>` to it to dial out.
- **Session** — a per-connection actor that wraps a single `IpcConnection`, routes inbound
  frames to the right local actor, forwards outbound messages, and correlates request/response
  tags.
- **RemoteAddressable** _(re-exported from `acktor`)_ — derive on an actor (with
  `#[message(M1, M2, ...)]`) to declare the message types it can receive from other processes.
  Messages must implement `MessageId`, `Encode`, and `Decode`; their `Result`s must implement
  `Encode` + `Decode`.
- **RemoteSpawnable** _(re-exported from `acktor`)_ — implement to allow other processes to spawn
  this actor on this node.
- **`#[remote]`** — attribute applied to the `impl Actor for ...` block of a remote-addressable
  actor; required so the actor exposes a remote mailbox.

## Example

A minimal message definition for IPC looks like:

```rust,ignore
use acktor::{Message, MessageId};
use acktor_ipc::{Decode, Encode};
use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout};

#[derive(
    Debug, Clone, Copy,
    KnownLayout, Immutable, FromBytes, IntoBytes,
    Message, MessageId, Encode, Decode,
)]
#[codec(zerocopy)]
#[result_type(())]
#[repr(C)]
pub struct Ping {
    pub id: u64,
    pub timestamp: i64,
}
```

See [`examples/pingpong`](./examples/pingpong) for a complete client/server walkthrough using the
WebSocket transport.

## Feature Flags

Defaults: `derive`.

| Feature     | Purpose                                        |
| ----------- | ---------------------------------------------- |
| `derive`    | Re-exports the `#[remote]` attribute macro.    |
| `pipe`      | Pipe transport (Unix sockets / Windows pipes). |
| `websocket` | WebSocket transport.                           |

Neither transport is enabled by default — enable `pipe` and/or `websocket` to pick the transports you want.

## License

This project is licensed under [MIT](../LICENSE).