arcbox-transport 0.4.17

Transport layer abstractions for ArcBox (Unix socket, vsock)
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

//! # arcbox-transport
//!
//! Transport layer abstractions for `ArcBox`.
//!
//! This crate provides transport implementations for communication:
//!
//! - [`UnixTransport`]: Unix domain sockets (CLI ↔ Daemon, Docker compatibility)
//! - [`VsockTransport`]: Virtio socket (Host ↔ Guest)
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────────────┐
//! │               arcbox-transport                  │
//! │                                                 │
//! │  ┌─────────────┐          ┌─────────────────┐  │
//! │  │   Unix      │          │     Vsock       │  │
//! │  │  Transport  │          │   Transport     │  │
//! │  └──────┬──────┘          └────────┬────────┘  │
//! │         │                          │           │
//! │         ▼                          ▼           │
//! │  ┌─────────────┐          ┌─────────────────┐  │
//! │  │ /var/run/   │          │    vsock CID    │  │
//! │  │ arcbox.sock │          │    + port       │  │
//! │  └─────────────┘          └─────────────────┘  │
//! └─────────────────────────────────────────────────┘
//! ```

pub mod error;
pub mod unix;
pub mod vsock;

pub use error::{Result, TransportError};
pub use unix::UnixTransport;
pub use vsock::VsockTransport;

use async_trait::async_trait;
use bytes::Bytes;

/// Transport trait for sending and receiving messages.
#[async_trait]
pub trait Transport: Send + Sync {
    /// Connects to the remote endpoint.
    async fn connect(&mut self) -> Result<()>;

    /// Disconnects from the remote endpoint.
    async fn disconnect(&mut self) -> Result<()>;

    /// Sends a message.
    async fn send(&mut self, data: Bytes) -> Result<()>;

    /// Receives a message.
    async fn recv(&mut self) -> Result<Bytes>;

    /// Returns whether the transport is connected.
    fn is_connected(&self) -> bool;
}

/// Transport listener for accepting connections.
#[async_trait]
pub trait TransportListener: Send + Sync {
    /// The transport type for accepted connections.
    type Transport: Transport;

    /// Binds to the endpoint.
    async fn bind(&mut self) -> Result<()>;

    /// Accepts a new connection.
    async fn accept(&mut self) -> Result<Self::Transport>;

    /// Closes the listener.
    async fn close(&mut self) -> Result<()>;
}