From 49e25688f11136d6e7378a48412b3fd7423de521 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Thu, 30 Sep 2021 12:31:38 +0200 Subject: [PATCH] rename CommandoSocket to CommandSocket --- proxmox-rest-server/src/api_config.rs | 10 +++++----- proxmox-rest-server/src/command_socket.rs | 14 ++++++++------ proxmox-rest-server/src/worker_task.rs | 6 +++--- src/bin/proxmox-backup-api.rs | 2 +- src/bin/proxmox-backup-manager.rs | 2 +- src/bin/proxmox-backup-proxy.rs | 2 +- src/bin/proxmox-daily-update.rs | 2 +- tests/worker-task-abort.rs | 4 ++-- 8 files changed, 22 insertions(+), 20 deletions(-) diff --git a/proxmox-rest-server/src/api_config.rs b/proxmox-rest-server/src/api_config.rs index 712c591b..39178543 100644 --- a/proxmox-rest-server/src/api_config.rs +++ b/proxmox-rest-server/src/api_config.rs @@ -14,7 +14,7 @@ use serde::Serialize; use proxmox::api::{ApiMethod, Router, RpcEnvironmentType}; use proxmox::tools::fs::{create_path, CreateOptions}; -use crate::{ApiAuth, FileLogger, FileLogOptions, CommandoSocket}; +use crate::{ApiAuth, FileLogger, FileLogOptions, CommandSocket}; pub type GetIndexFn = fn(Option, Option, &ApiConfig, Parts) -> Response; @@ -182,13 +182,13 @@ impl ApiConfig { /// /// When enabled, all requests are logged to the specified file. /// This function also registers a `api-access-log-reopen` - /// command one the [CommandoSocket]. + /// command one the [CommandSocket]. pub fn enable_access_log

( &mut self, path: P, dir_opts: Option, file_opts: Option, - commando_sock: &mut CommandoSocket, + commando_sock: &mut CommandSocket, ) -> Result<(), Error> where P: Into @@ -221,13 +221,13 @@ impl ApiConfig { /// /// When enabled, all authentification requests are logged to the /// specified file. This function also registers a - /// `api-auth-log-reopen` command one the [CommandoSocket]. + /// `api-auth-log-reopen` command one the [CommandSocket]. pub fn enable_auth_log

( &mut self, path: P, dir_opts: Option, file_opts: Option, - commando_sock: &mut CommandoSocket, + commando_sock: &mut CommandSocket, ) -> Result<(), Error> where P: Into diff --git a/proxmox-rest-server/src/command_socket.rs b/proxmox-rest-server/src/command_socket.rs index 511ad561..46814c4f 100644 --- a/proxmox-rest-server/src/command_socket.rs +++ b/proxmox-rest-server/src/command_socket.rs @@ -148,23 +148,25 @@ where } // A callback for a specific commando socket. -type CommandoSocketFn = Box<(dyn Fn(Option<&Value>) -> Result + Send + Sync + 'static)>; +type CommandSocketFn = Box<(dyn Fn(Option<&Value>) -> Result + Send + Sync + 'static)>; /// Tooling to get a single control command socket where one can /// register multiple commands dynamically. /// -/// You need to call `spawn()` to make the socket active. -pub struct CommandoSocket { +/// The socket is activated by calling [spawn](CommandSocket::spawn), +/// which spawns an async tokio task to process the commands. +pub struct CommandSocket { socket: PathBuf, gid: Gid, - commands: HashMap, + commands: HashMap, } -impl CommandoSocket { +impl CommandSocket { + /// Creates a new instance. pub fn new

(path: P, gid: Gid) -> Self where P: Into, { - CommandoSocket { + CommandSocket { socket: path.into(), gid, commands: HashMap::new(), diff --git a/proxmox-rest-server/src/worker_task.rs b/proxmox-rest-server/src/worker_task.rs index dea78b5a..0ac3f431 100644 --- a/proxmox-rest-server/src/worker_task.rs +++ b/proxmox-rest-server/src/worker_task.rs @@ -23,7 +23,7 @@ use proxmox::api::upid::UPID; use pbs_tools::task::WorkerTaskContext; use pbs_tools::logrotate::{LogRotate, LogRotateFiles}; -use crate::{CommandoSocket, FileLogger, FileLogOptions}; +use crate::{CommandSocket, FileLogger, FileLogOptions}; struct TaskListLockGuard(File); @@ -324,7 +324,7 @@ pub fn worker_is_active_local(upid: &UPID) -> bool { } } -/// Register task control command on a [CommandoSocket]. +/// Register task control command on a [CommandSocket]. /// /// This create two commands: /// @@ -333,7 +333,7 @@ pub fn worker_is_active_local(upid: &UPID) -> bool { /// * ``worker-task-status ``: return true of false, depending on /// whether the worker is running or stopped. pub fn register_task_control_commands( - commando_sock: &mut CommandoSocket, + commando_sock: &mut CommandSocket, ) -> Result<(), Error> { fn get_upid(args: Option<&Value>) -> Result { let args = if let Some(args) = args { args } else { bail!("missing args") }; diff --git a/src/bin/proxmox-backup-api.rs b/src/bin/proxmox-backup-api.rs index 275876e5..713f7f19 100644 --- a/src/bin/proxmox-backup-api.rs +++ b/src/bin/proxmox-backup-api.rs @@ -80,7 +80,7 @@ async fn run() -> Result<(), Error> { )?; let backup_user = pbs_config::backup_user()?; - let mut commando_sock = proxmox_rest_server::CommandoSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); + let mut commando_sock = proxmox_rest_server::CommandSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); let dir_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); let file_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); diff --git a/src/bin/proxmox-backup-manager.rs b/src/bin/proxmox-backup-manager.rs index 87f7034d..eca1540e 100644 --- a/src/bin/proxmox-backup-manager.rs +++ b/src/bin/proxmox-backup-manager.rs @@ -409,7 +409,7 @@ async fn run() -> Result<(), Error> { let file_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); proxmox_rest_server::init_worker_tasks(pbs_buildcfg::PROXMOX_BACKUP_LOG_DIR_M!().into(), file_opts.clone())?; - let mut commando_sock = proxmox_rest_server::CommandoSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); + let mut commando_sock = proxmox_rest_server::CommandSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); proxmox_rest_server::register_task_control_commands(&mut commando_sock)?; commando_sock.spawn()?; } diff --git a/src/bin/proxmox-backup-proxy.rs b/src/bin/proxmox-backup-proxy.rs index 617fd45a..17a100a1 100644 --- a/src/bin/proxmox-backup-proxy.rs +++ b/src/bin/proxmox-backup-proxy.rs @@ -187,7 +187,7 @@ async fn run() -> Result<(), Error> { config.register_template("console", "/usr/share/pve-xtermjs/index.html.hbs")?; let backup_user = pbs_config::backup_user()?; - let mut commando_sock = proxmox_rest_server::CommandoSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); + let mut commando_sock = proxmox_rest_server::CommandSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); let dir_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); let file_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); diff --git a/src/bin/proxmox-daily-update.rs b/src/bin/proxmox-daily-update.rs index 2a04a559..17f79247 100644 --- a/src/bin/proxmox-daily-update.rs +++ b/src/bin/proxmox-daily-update.rs @@ -91,7 +91,7 @@ async fn run(rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> { let file_opts = CreateOptions::new().owner(backup_user.uid).group(backup_user.gid); proxmox_rest_server::init_worker_tasks(pbs_buildcfg::PROXMOX_BACKUP_LOG_DIR_M!().into(), file_opts.clone())?; - let mut commando_sock = proxmox_rest_server::CommandoSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); + let mut commando_sock = proxmox_rest_server::CommandSocket::new(proxmox_rest_server::our_ctrl_sock(), backup_user.gid); proxmox_rest_server::register_task_control_commands(&mut commando_sock)?; commando_sock.spawn()?; diff --git a/tests/worker-task-abort.rs b/tests/worker-task-abort.rs index ed2d81a0..1fdea606 100644 --- a/tests/worker-task-abort.rs +++ b/tests/worker-task-abort.rs @@ -11,7 +11,7 @@ use proxmox::tools::fs::CreateOptions; use pbs_api_types::{Authid, UPID}; use pbs_tools::{task_log, task::WorkerTaskContext}; -use proxmox_rest_server::{CommandoSocket, WorkerTask}; +use proxmox_rest_server::{CommandSocket, WorkerTask}; fn garbage_collection(worker: &WorkerTask) -> Result<(), Error> { @@ -48,7 +48,7 @@ fn worker_task_abort() -> Result<(), Error> { let rt = tokio::runtime::Runtime::new().unwrap(); rt.block_on(async move { - let mut commando_sock = CommandoSocket::new( + let mut commando_sock = CommandSocket::new( proxmox_rest_server::our_ctrl_sock(), nix::unistd::Gid::current()); let init_result: Result<(), Error> = try_block!({ -- 2.39.2