vortex-protocol 0.1.4

A P2P file transfer protocol
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

# Vortex Protocol

[![LICENSE](https://img.shields.io/github/license/dragonflyoss/vortex-protocol.svg?style=flat-square)](https://github.com/dragonflyoss/vortex-protocol/blob/main/LICENSE)
[![Discussions](https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square)](https://github.com/dragonflyoss/vortex-protocol/discussions)

## Introduction

Vortex protocol is a high-performance peer-to-peer (P2P) file transfer protocol implementation in Rust,
designed as part of the Dragonfly project. It utilizes the TLV (Tag-Length-Value) format for
efficient and flexible data transmission, making it ideal for large-scale file distribution scenarios.

### Features

- **Efficient TLV Protocol**: Optimized for fast serialization and deserialization of data packets.
- **Large File Support**: Handles piece sizes up to 1 GiB and value fields up to 4 GiB.
- **Memory Safety**: Built in Rust with zero-cost abstractions and memory safety guarantees.
- **High Performance**: Designed for high-throughput file transfer scenarios.
- **Extensible Design**: Reserved tags for future protocol extensions like compression and encryption.

## Documentation

For details, please see [the specification](docs/README.md).

## Benchmarking

Vortex protocol includes comprehensive benchmarks for packet creation, serialization, and deserialization:

```bash
# Run all benchmarks
cargo bench

# Run specific benchmark group
cargo bench "Vortex Packet Creation"
```