Struct dpdk_unix::daemonize::Daemonize

pub struct Daemonize {
    pub working_folder_path: PathBuf,
    pub pid_folder_path: PathBuf,
    pub user_name: CString,
}

An object that can be used with a configuration file (eg via Serde) to configure a daemon.

The following are done:-

• umask is set to just the current user
• Checks are made to check the program is not running with the set uid bit set ('setuid' or 'suid').
• A PID file is created
• standard in is redirected to /dev/null.
• standard out and error are redirected to /dev/null.
• fprintf and friends using the FILE API are redirected to syslog on Linux (this is probably also possible to implement for FreeBSD - see https://mischasan.wordpress.com/2011/05/25/redirecting-stderr-to-syslog/).
• Double forking and a new session are created.
• Real and effective user and group ids are changed.
• Additional groups from /etc/group, if any, are assigned.
• Environment variables are populated if missing (IFS, PATH)
• User environment variables are overwritten (HOME, LOGNAME, USER).

Fields

working_folder_path: PathBuf

The folder path to use as the 'current working directory' (CWD).

Equivalent functionality to the shell command chdir.

Defaults to /.

pid_folder_path: PathBuf

A folder path in which to put a PID file.

This uses the processes' name for the actual file base name.

Defaults to /var/run.

user_name: CString

An user name that must exist in /etc/passwd (or the local equivalent).

Use to discover runtime user and groups to change to and the home folder of the running user.

Methods

impl Daemonize

pub fn daemonize(self) -> DaemonizeCleanUpOnExit

Daemonizes the current process.

Returns an object that needs to have clean_up() called on it just before process exit.

Does the following:-

• Verifies we are not running setuid.
• Sets an initial sane umask (0000).
• Switches user to self.user_name.
• Sets up a PID file in self.pid_folder_path.
• Changes the current working directory to self.working_folder_path.
• Redirects standard in, standard out and standard error to /dev/null before (only on Linux) trying to redirect FILE stream handles to syslog.
• Forks.
• Creates a process group, and detaches from the session's controlling terminal.
• Forks.
• Populates the PID file.
• Makes sure the IFS environment variable is sane (\t\n).
• Makes sure the PATH environment variable is /usr/local/bin:/usr/bin.
• Returns an object that needs to have clean_up() called on it just before process exit.

Trait Implementations

impl Eq for Daemonize

impl PartialOrd<Daemonize> for Daemonize

fn partial_cmp(&self, other: &Daemonize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Daemonize) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Daemonize) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Daemonize) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Daemonize) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Default for Daemonize

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Daemonize> for Daemonize

fn eq(&self, other: &Daemonize) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Daemonize) -> bool

This method tests for !=.

impl Clone for Daemonize

fn clone(&self) -> Daemonize

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Ord for Daemonize

fn cmp(&self, other: &Daemonize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Debug for Daemonize

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

Formats the value using the given formatter.

impl Hash for Daemonize

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Serialize for Daemonize

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where     __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Daemonize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.