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
// Copyright 2015-2018 Parity Technologies (UK) Ltd. // This file is part of Parity. // Parity is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // Parity is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with Parity. If not, see <http://www.gnu.org/licenses/>. use crate::error::{Error, ErrorKind}; use std::path::PathBuf; pub mod error; mod platform; type Result<T> = std::result::Result<T, Error>; /// Handle returned from `daemonize` to the daemon process /// the daemon should use this handle to detach itself from the /// parent process, In cases where your program needs to run set up before starting /// this can be useful, as the daemon will pipe it's stdout/stderr to the parent process /// to communicate if start up was successful pub trait AsHandle { type Fd; /// Creates a `Handle` from a raw file descriptor fn from_fd(fd: Self::Fd) -> Self; /// Detach the daemon from the parent process /// this will write "Daemon started successfully" to stdout /// before detaching /// /// # panics /// if detach is called more than once fn detach(&mut self); /// Detach the daemon from the parent process /// with a custom message to be printed to stdout before detaching /// /// # panics /// if detach_with_msg is called more than once fn detach_with_msg<T: AsRef<[u8]>>(&mut self, msg: T); } #[macro_export] macro_rules! map_err { ($e:expr, $err:expr) => { match $e { -1 => { Err::<_, crate::error::Error>(From::from($err)) } other => Ok(other), } }; } /// this will fork the calling process twice and return a handle to the /// grandchild process aka daemon, use the handle to detach from the parent process /// /// before `Handle::detach` is called the daemon process has it's STDOUT/STDERR /// piped to the parent process' STDOUT/STDERR, this way any errors encountered by the /// daemon during start up is reported. pub fn daemonize<T: Into<PathBuf>>(pid_file: T) -> Result<impl AsHandle> { platform::daemonize(pid_file) }