pocketscion 0.3.0

A lightweight SCION network simulator
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// Copyright 2025 Anapaya Systems
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! PocketSCION CLI options.

use std::path::PathBuf;

use clap::{Args, Parser, Subcommand};

use crate::runtime::DEFAULT_MGMT_PORT;

/// PocketSCION
#[derive(Debug, Parser)]
#[command(author, version, about, long_about = None)]
pub struct Opts {
    /// Top-level subcommand
    #[command(subcommand)]
    pub command: Commands,

    /// Logging options
    #[command(flatten)]
    pub logging: LoggingOptions,

    /// Management API options
    #[command(flatten)]
    pub management: ManagementOptions,
}

/// Management API options.
#[derive(Debug, Args)]
pub struct ManagementOptions {
    /// The port for the management API to listen on (e.g. 9000).
    #[arg(long, global = true, default_value_t = DEFAULT_MGMT_PORT)]
    pub mgmt_port: u16,
}

/// Logging options.
#[derive(Debug, Args)]
pub struct LoggingOptions {
    /// Log pocket SCION output to stderr.
    #[arg(long, global = true, default_value = "true")]
    #[clap(global = true)]
    pub stderr: bool,

    /// Directory for the pocket SCION log.
    #[arg(long, global = true)]
    pub log_dir: Option<PathBuf>,
}

/// Top-level subcommands.
#[derive(Debug, Subcommand)]
pub enum Commands {
    /// Start PocketSCION.
    Run {
        /// The file to optionally load the system state from.
        #[arg(long)]
        state_file: Option<PathBuf>,

        /// The file to optionally load the I/O state from.
        #[arg(long)]
        io_config_file: Option<PathBuf>,

        /// Sets the start time to the UNIX EPOCH plus the number of seconds
        /// specified.
        #[arg(long)]
        start_time_sec: Option<u64>,

        /// Specifies the nanoseconds of the start time.
        ///
        /// Ignored if `start_time_sec` is not specified. This is primarily to
        /// ensure consistency between in-memory and subprocess runtime.
        #[arg(long, hide = true)]
        start_time_subsec: Option<u32>,
    },
}