aurpc 0.3.1

Asynchronous UDP RPCs
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

[![Build Status](https://drone.ureeves.com/api/badges/ureeves/aurpc/status.svg)](https://drone.ureeves.com/ureeves/aurpc)
[![Docs](https://docs.rs/aurpc/badge.svg)](https://docs.rs/aurpc)

# aurpc

Asynchronous UDP RPCs.

Exposes a socket-like interface allowing for sending requests and awaiting a
response as well as listening to requests, with UDP as transport.

This is achieved by implementing an 24-bit protocol header on top of UDP
containing 8-bit flags and a 16-bit request id.

```
                    1                   2
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Flags     |           Request Id          |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
```

Since a UDP datagram can carry a maximum of 65507 data bytes. This means
that, with the added overhead, each message can be a maximum of `65504
bytes`.

## Examples

```rust
use aurpc::RpcSocket;

let socket = RpcSocket::bind("127.0.0.1:8080").await?;
let mut buf = vec![0u8; 1024];

loop {
    let (n, responder) = socket.recv_from(&mut buf).await?;
    responder.respond(&buf[..n]).await?;
}
```

# License

This crate is licensed under the MIT license. See the [license](License.txt) for
more details.