]> git.proxmox.com Git - proxmox-backup.git/commitdiff
projects / proxmox-backup.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: d7eedbd)
rename CommandoSocket to CommandSocket
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 30 Sep 2021 10:31:38 +0000 (12:31 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Thu, 30 Sep 2021 10:52:35 +0000 (12:52 +0200)
proxmox-rest-server/src/api_config.rs patch | blob | blame | history
proxmox-rest-server/src/command_socket.rs patch | blob | blame | history
proxmox-rest-server/src/worker_task.rs patch | blob | blame | history
src/bin/proxmox-backup-api.rs patch | blob | blame | history
src/bin/proxmox-backup-manager.rs patch | blob | blame | history
src/bin/proxmox-backup-proxy.rs patch | blob | blame | history
src/bin/proxmox-daily-update.rs patch | blob | blame | history
tests/worker-task-abort.rs patch | blob | blame | history

diff --git a/proxmox-rest-server/src/api_config.rs b/proxmox-rest-server/src/api_config.rs
index 712c591b96c585686bbb2385c735cf6bf88fefc5..391785438b20dd3e06ae9c21a012bde5e039b025 100644 (file)
--- 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<String>, Option<String>, &ApiConfig, Parts) -> Response<Body>;
 
@@ -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<P>(
         &mut self,
         path: P,
         dir_opts: Option<CreateOptions>,
         file_opts: Option<CreateOptions>,
-        commando_sock: &mut CommandoSocket,
+        commando_sock: &mut CommandSocket,
     ) -> Result<(), Error>
     where
         P: Into<PathBuf>
@@ -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<P>(
         &mut self,
         path: P,
         dir_opts: Option<CreateOptions>,
         file_opts: Option<CreateOptions>,
-        commando_sock: &mut CommandoSocket,
+        commando_sock: &mut CommandSocket,
     ) -> Result<(), Error>
     where
         P: Into<PathBuf>
diff --git a/proxmox-rest-server/src/command_socket.rs b/proxmox-rest-server/src/command_socket.rs
index 511ad561087f253daa328b09d10842e31d9a260d..46814c4f0f2fb61b5dabdfdfc1d369bc986d08bd 100644 (file)
--- 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<Value, Error> + Send + Sync + 'static)>;
+type CommandSocketFn = Box<(dyn Fn(Option<&Value>) -> Result<Value, Error> + 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<String, CommandoSocketFn>,
+    commands: HashMap<String, CommandSocketFn>,
 }
 
-impl CommandoSocket {
+impl CommandSocket {
+    /// Creates a new instance.
     pub fn new<P>(path: P, gid: Gid) -> Self
         where P: Into<PathBuf>,
     {
-        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 dea78b5ade2f0dd910ae945c5c94020c6e951e60..0ac3f4318bb99cc0dac94e3a248e73b305547c8b 100644 (file)
--- 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 <UPID>``: 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<UPID, Error> {
         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 275876e5045bc34b2e308d0fb6bfca3d785567a3..713f7f19504c401996a3745ae5f2beca59f1825b 100644 (file)
--- 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 87f7034d934209c73dfe636d56b859243acfc0ba..eca1540ef2700b619f816c5530bd4a2b3cb3e345 100644 (file)
--- 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 617fd45a62a9b9f8dc3afd525c22782cacc30135..17a100a1b77b74f6d61a94aa5b4ac6fe6adfbe06 100644 (file)
--- 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 2a04a559f8a9d153effe7682fd7a64b2d6b974ce..17f79247a60491d0f1efebe6330085eae2585ddd 100644 (file)
--- 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 ed2d81a08e5da1923cb76665588318929942c178..1fdea606d681bc862bfba1f4d054cb2eb563567e 100644 (file)
--- 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!({
Proxmox Backup Server and Client