ferrotunnel-protocol 1.0.6

Wire protocol for FerroTunnel reverse tunnel
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

# ferrotunnel-protocol

[![Crates.io](https://img.shields.io/crates/v/ferrotunnel-protocol)](https://crates.io/crates/ferrotunnel-protocol)
[![Documentation](https://docs.rs/ferrotunnel-protocol/badge.svg)](https://docs.rs/ferrotunnel-protocol)

Wire protocol definitions and codec for [FerroTunnel](https://github.com/ferro-labs/ferrotunnel).

## Overview

This crate defines the binary protocol used for tunnel communication:

- **12 frame types** for control, data, and keepalive
- **Length-prefixed codec** (4-byte length + 1-byte type) with bincode control frames
- **16MB max frame size** with validation

## Frame Types

### Control Frames
- `Handshake` / `HandshakeAck` - Connection establishment
- `Register` / `RegisterAck` - Tunnel registration

### Stream Frames
- `OpenStream` / `StreamAck` - Stream creation
- `Data` - Payload transfer
- `CloseStream` - Stream termination

### Keepalive
- `Heartbeat` / `HeartbeatAck` - Connection health

### Other
- `Error` - Error reporting
- `PluginData` - Plugin communication

## Usage

```rust
use ferrotunnel_protocol::{Frame, TunnelCodec};
use tokio_util::codec::{Framed, Decoder};

// Create a codec for framing
let codec = TunnelCodec::new();

// Create frames
let frame = Frame::Heartbeat { 
    timestamp: 1234567890 
};
```

## License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.