Struct DrainArgs 

pub struct DrainArgs {
    pub admin_url: Option<String>,
    pub config: Option<PathBuf>,
    pub json: bool,
    pub timeout_ms: u64,
    pub wait: bool,
    pub wait_timeout_secs: NonZeroU64,
    pub wait_poll_ms: NonZeroU64,
}

decdn node drain — trigger graceful shutdown of the running node via admin_v1_drain (issue #244, adr/appendix-local-admin-http.md). Fires the same runtime shutdown path as SIGTERM without needing the process PID.

Without --wait, the command is fire-and-forget: it returns drain_initiated=true as soon as the trigger lands and the admin server begins its early-stop sequence (metrics, then admin, both before router.shutdown). The connection will close before the node fully exits — observe completion via process exit (systemd/K8s) or decdn node health until ECONNREFUSED.

Pass --wait (issue #604) to opt the runtime into keeping the admin server alive through router.shutdown and have the CLI poll admin_v1_health.in_flight_streams until it reaches 0 (or the wait budget expires). On a clean drain the command returns success once the count is zero; on overrun it prints drain_timeout=true in_flight_streams=N to stderr and exits non-zero so operator scripts can fail closed during a stuck rolling upgrade.

Fields

admin_url: Option<String>

Base URL of the node’s admin HTTP surface. See health --admin-url for resolution precedence (flag → env → config → default).

config: Option<PathBuf>

Path to the TOML config file used to derive the admin URL when --admin-url / DECDN_ADMIN_URL are unset.

json: bool

Emit the admin response as JSON instead of a one-line confirmation.

timeout_ms: u64

Roundtrip timeout in milliseconds for each individual RPC (the initial drain call and each poll under --wait).

wait: bool

Block until all in-flight client streams complete (or the wait budget expires) before returning. Opt-in seam for #604: when set, the server keeps admin alive through router.shutdown so the CLI can poll admin_v1_health.in_flight_streams to observe completion. Without it, the original SIGTERM-equivalent ordering applies.

wait_timeout_secs: NonZeroU64

Wall-clock budget (seconds) for the --wait polling loop. On overrun the CLI exits non-zero and prints drain_timeout=true. Ignored without --wait. Default 30s covers the runtime’s 15s SHUTDOWN_DEADLINE plus typical settle time. NonZeroU64 so clap rejects 0 at parse time — a zero-second budget would deadline-overrun on the first iteration with no signal of why.

wait_poll_ms: NonZeroU64

Cadence (milliseconds) at which --wait polls admin_v1_health. Lower values converge faster on short drains; higher values reduce admin churn on long ones. Ignored without --wait. NonZeroU64 so clap rejects 0 at parse time — a zero-millisecond poll interval would spin a busy loop against the loopback admin port.

Trait Implementations

impl Args for DrainArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for DrainArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for DrainArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.