arcbox-protocol 0.1.6

//! # arcbox-protocol
//!
//! Protocol definitions for `ArcBox` communication.
//!
//! This crate defines the message types and service interfaces used for
//! communication between:
//!
//! - CLI <-> Daemon (ttrpc over Unix socket)
//! - Host <-> Guest (ttrpc over vsock)
//! - Docker CLI <-> Daemon (REST API, handled by arcbox-docker)
//!
//! ## Protocol Buffers
//!
//! The protocol is defined using Protocol Buffers for efficient serialization.
//! Message types are generated at build time from `.proto` files.
//!
//! All types are defined under the `arcbox.v1` package and re-exported here.
//!
//! ## Module Structure
//!
//! Types can be accessed via:
//! - `arcbox_protocol::v1::TypeName` - canonical path
//! - `arcbox_protocol::TypeName` - convenient re-exports
//! - `arcbox_protocol::agent::TypeName` - backward compatible submodules
//!
//! ## Services
//!
//! Service definitions are available for:
//! - Container lifecycle operations
//! - Image management
//! - Virtual machine management
//! - Guest agent operations
//! - Network, volume, and system operations (API layer)

mod generated;

// Re-export the generated module as v1 (canonical path)
pub use generated::arcbox_v1 as v1;

// Re-export the sandbox.v1 generated module.
pub use generated::sandbox_v1;

// =============================================================================
// Backward compatible module re-exports
// =============================================================================

/// Common types (from common.proto).
///
/// Re-exports all types for backward compatibility.
pub mod common {
    pub use super::v1::{Empty, KeyValue, Mount, PortBinding, ResourceLimits, Timestamp};
}

/// Machine types (from machine.proto).
///
/// Re-exports all machine-related types for backward compatibility.
pub mod machine {
    pub use super::v1::{
        CreateMachineRequest, CreateMachineResponse, DirectoryMount, InspectMachineRequest,
        ListMachinesRequest, ListMachinesResponse, MachineExecOutput, MachineExecRequest,
        MachineHardware, MachineInfo, MachineNetwork, MachineOs, MachineStorage, MachineSummary,
        RemoveMachineRequest, SshInfoRequest, SshInfoResponse, StartMachineRequest,
        StopMachineRequest,
    };
}

/// Container types (from container.proto).
///
/// Re-exports all container-related types for backward compatibility.
pub mod container {
    pub use super::v1::{
        AttachInput, AttachOutput, ContainerConfig, ContainerInfo, ContainerState,
        ContainerStatsRequest, ContainerStatsResponse, ContainerSummary, ContainerTopRequest,
        ContainerTopResponse, CreateContainerRequest, CreateContainerResponse, ExecCreateRequest,
        ExecCreateResponse, ExecOutput, ExecStartRequest, InspectContainerRequest,
        KillContainerRequest, ListContainersRequest, ListContainersResponse, LogEntry, LogsRequest,
        MountPoint, NetworkSettings, PauseContainerRequest, ProcessRow, RemoveContainerRequest,
        StartContainerRequest, StopContainerRequest, UnpauseContainerRequest, WaitContainerRequest,
        WaitContainerResponse,
    };
}

/// Image types (from image.proto).
///
/// Re-exports all image-related types for backward compatibility.
pub mod image {
    pub use super::v1::{
        BuildContext, BuildProgress, ExistsImageRequest, ExistsImageResponse, ImageConfig,
        ImageInfo, ImageSummary, InspectImageRequest, ListImagesRequest, ListImagesResponse,
        PullImageRequest, PullProgress, PushImageRequest, PushProgress, RemoveImageRequest,
        RemoveImageResponse, RootFs, TagImageRequest,
    };
}

/// Agent types (from agent.proto).
///
/// Re-exports all agent-related types for backward compatibility.
pub mod agent {
    pub use super::v1::{
        AgentPingRequest, AgentPingResponse, PortBindingsChanged, PortBindingsRemoved,
        RuntimeEnsureRequest, RuntimeEnsureResponse, RuntimeStatusRequest, RuntimeStatusResponse,
        ServiceStatus, SystemInfo,
    };

    // Backward compatibility type aliases (short names without Agent prefix).
    pub type PingRequest = super::v1::AgentPingRequest;
    pub type PingResponse = super::v1::AgentPingResponse;
}

/// API types (from api.proto).
///
/// Re-exports network, volume, and system service types.
pub mod api {
    // Network service types
    pub use super::v1::{
        CreateNetworkRequest, CreateNetworkResponse, InspectNetworkRequest, IpamConfig, IpamSubnet,
        ListNetworksRequest, ListNetworksResponse, NetworkContainer, NetworkInfo, NetworkSummary,
        RemoveNetworkRequest,
    };

    // System service types
    pub use super::v1::{
        Event, EventActor, EventsRequest, GetInfoRequest, GetInfoResponse, GetVersionRequest,
        GetVersionResponse, PruneRequest, PruneResponse, SystemPingRequest, SystemPingResponse,
    };

    // Volume service types
    pub use super::v1::{
        CreateVolumeRequest, CreateVolumeResponse, InspectVolumeRequest, ListVolumesRequest,
        ListVolumesResponse, RemoveVolumeRequest, VolumeInfo, VolumeUsage,
    };

    // Shell/interactive session types
    pub use super::v1::{ShellInput, ShellOutput, TerminalSize};
}

// =============================================================================
// Convenient crate-level re-exports
// =============================================================================

// Common types
pub use v1::{Empty, KeyValue, Mount, PortBinding, ResourceLimits, Timestamp};

// Machine types
pub use v1::{
    CreateMachineRequest, CreateMachineResponse, DirectoryMount, InspectMachineRequest,
    ListMachinesRequest, ListMachinesResponse, MachineExecOutput, MachineExecRequest,
    MachineHardware, MachineInfo, MachineNetwork, MachineOs, MachineStorage, MachineSummary,
    RemoveMachineRequest, SshInfoRequest, SshInfoResponse, StartMachineRequest, StopMachineRequest,
};

// Container types
pub use v1::{
    AttachInput, AttachOutput, ContainerConfig, ContainerInfo, ContainerState,
    ContainerStatsRequest, ContainerStatsResponse, ContainerSummary, ContainerTopRequest,
    ContainerTopResponse, CreateContainerRequest, CreateContainerResponse, ExecCreateRequest,
    ExecCreateResponse, ExecOutput, ExecStartRequest, InspectContainerRequest,
    KillContainerRequest, ListContainersRequest, ListContainersResponse, LogEntry, LogsRequest,
    MountPoint, NetworkSettings, PauseContainerRequest, ProcessRow, RemoveContainerRequest,
    StartContainerRequest, StopContainerRequest, UnpauseContainerRequest, WaitContainerRequest,
    WaitContainerResponse,
};

// Image types
pub use v1::{
    BuildContext, BuildProgress, ExistsImageRequest, ExistsImageResponse, ImageConfig, ImageInfo,
    ImageSummary, InspectImageRequest, ListImagesRequest, ListImagesResponse, PullImageRequest,
    PullProgress, PushImageRequest, PushProgress, RemoveImageRequest, RemoveImageResponse, RootFs,
    TagImageRequest,
};

// Agent types
pub use v1::{
    AgentPingRequest, AgentPingResponse, PortBindingsChanged, PortBindingsRemoved,
    RuntimeEnsureRequest, RuntimeEnsureResponse, RuntimeStatusRequest, RuntimeStatusResponse,
    ServiceStatus, SystemInfo,
};

// API types - Network
pub use v1::{
    CreateNetworkRequest, CreateNetworkResponse, InspectNetworkRequest, IpamConfig, IpamSubnet,
    ListNetworksRequest, ListNetworksResponse, NetworkContainer, NetworkInfo, NetworkSummary,
    RemoveNetworkRequest,
};

// API types - System
pub use v1::{
    Event, EventActor, EventsRequest, GetInfoRequest, GetInfoResponse, GetVersionRequest,
    GetVersionResponse, PruneRequest, PruneResponse, SystemPingRequest, SystemPingResponse,
};

// API types - Volume
pub use v1::{
    CreateVolumeRequest, CreateVolumeResponse, InspectVolumeRequest, ListVolumesRequest,
    ListVolumesResponse, RemoveVolumeRequest, VolumeInfo, VolumeUsage,
};

// API types - Shell
pub use v1::{ShellInput, ShellOutput, TerminalSize};

// =============================================================================
// Backward compatibility type aliases at crate level
// =============================================================================

/// Backward compatibility: Ping request (alias for `AgentPingRequest`).
pub type PingRequest = AgentPingRequest;

/// Backward compatibility: Ping response (alias for `AgentPingResponse`).
pub type PingResponse = AgentPingResponse;