ceviche 0.7.0

Rust daemon/service wrapper
Documentation 
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

use std::sync::mpsc;

use crate::Error;
use crate::ServiceEvent;

cfg_if! {
    if #[cfg(windows)] {
        mod windows;
        pub use self::windows::WindowsController as Controller;
        pub use self::windows::Session as Session;
        pub use self::windows::dispatch;
    } else if #[cfg(target_os = "macos")] {
        mod macos;
        pub use self::macos::MacosController as Controller;
        pub use self::macos::Session as Session;
        pub use self::macos::dispatch;
        pub use self::macos::LaunchAgentTargetSesssion;
    } else if #[cfg(target_os = "linux")] {
        mod linux;
        pub use self::linux::LinuxController as Controller;
        pub use self::linux::Session as Session;
        pub use self::linux::dispatch;
    } else {
        mod dummy;
        pub use self::dummy::DummyController as Controller;
        pub use self::dummy::Session as Session;
    }
}

/// Signature of the service main function.
/// `rx` receives the events that are sent to the service. `tx` can be used to send custom events on the channel.
/// `args` is the list or arguments that were passed to the service. When `standalone_mode` is true, the service
/// main function is being called directly (outside of the system service support).
pub type ServiceMainFn<T> = fn(
    rx: mpsc::Receiver<ServiceEvent<T>>,
    tx: mpsc::Sender<ServiceEvent<T>>,
    args: Vec<String>,
    standalone_mode: bool,
) -> u32;

/// Controllers implement this interface. They also need to implement the `register()` method; because the signature
/// of service_main_wrapper depends on the system the method is not part of the interface.
pub trait ControllerInterface {
    /// Creates the service on the system.
    fn create(&mut self) -> Result<(), Error>;
    /// Deletes the service.
    fn delete(&mut self) -> Result<(), Error>;
    /// Starts the service.
    fn start(&mut self) -> Result<(), Error>;
    /// Stops the service.
    fn stop(&mut self) -> Result<(), Error>;
    cfg_if! {
        if #[cfg(target_os = "macos")] {
            /// Loads the agent service.
            fn load(&mut self) -> Result<(), Error>;
            /// Unloads the agent service.
            fn unload(&mut self) -> Result<(), Error>;
        }
    }
}