ferrotunnel-core

Core tunnel implementation for FerroTunnel.

Overview

This crate provides the core tunnel logic:

• TunnelClient - Client-side tunnel connection
• TunnelServer - Server-side tunnel listener
• Multiplexer - Stream multiplexing over a single connection
• Session - Session management with heartbeat tracking
• TlsTransport - Encrypted transport support

Components

Tunnel

• TunnelClient - Connects to server, handles handshake, runs message loop
• TunnelServer - Listens for connections, authenticates clients, manages sessions

Stream

• Multiplexer - Multiplexes virtual streams over one TCP connection; frames are sent in priority order (Critical → High → Normal → Low).
• VirtualStream - AsyncRead/AsyncWrite implementation for tunneled data; created with a stream priority for QoS.
• open_stream / open_stream_with_priority - Open streams with default or specified priority.
• Bytes pool - Thread-local buffer pooling for zero-copy transfers (configurable via env).

Transport

• TCP transport - Standard TCP connection
• TLS support - Native TLS 1.3 encryption (rustls)

Usage

use ferrotunnel_core::{TunnelClient, TunnelServer};

// Server
let server = TunnelServer::new("0.0.0.0:7835".parse()?, "secret".into());
server.run().await?;

// Client
let mut client = TunnelClient::new("localhost:7835".into(), "secret".into());
client.connect_and_run(|stream| async { /* handle stream */ }).await?;

Configuration

Buffer pool limits (used by the stream layer) can be tuned via environment variables. Values are read once at first use.

License

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