17 releases

0.6.1 Sep 13, 2024
0.6.0 Mar 14, 2024
0.5.2 Apr 13, 2022
0.5.1 Jan 6, 2022
0.2.0 Sep 10, 2018

#236 in Unix APIs

Download history 325/week @ 2024-07-16 356/week @ 2024-07-23 412/week @ 2024-07-30 320/week @ 2024-08-06 435/week @ 2024-08-13 241/week @ 2024-08-20 249/week @ 2024-08-27 197/week @ 2024-09-03 223/week @ 2024-09-10 91/week @ 2024-09-17 180/week @ 2024-09-24 443/week @ 2024-10-01 183/week @ 2024-10-08 182/week @ 2024-10-15 403/week @ 2024-10-22 297/week @ 2024-10-29

1,156 downloads per month

MIT/Apache

50KB
1K SLoC

ceviche-rs

Cargo Documentation Build

Service/daemon wrapper. Supports Windows, Linux (systemd) and macOS.


lib.rs:

ceviche is a wrapper to write a service/daemon.

At the moment only Windows services are supported. The Service macro is inspired from the winservice crate.

A service implements a service main function and is generated by invoking the Service! macro. The events are sent to the service over the rx channel.

 enum CustomServiceEvent {}

fn my_service_main(
    rx: mpsc::Receiver<ServiceEvent<CustomServiceEvent>>,
    _tx: mpsc::Sender<ServiceEvent<CustomServiceEvent>>,
    args: Vec<String>,
    standalone_mode: bool) -> u32 {
   loop {
       if let Ok(control_code) = rx.recv() {
           match control_code {
               ServiceEvent::Stop => break,
               _ => (),
           }
       }
   }
   0
}

Service!("Foobar", my_service_main);

The Controller is a helper to create, remove, start or stop the service on the system. ceviche also supports a standalone mode were the service code runs as a normal executable which can be useful for development and debugging.

static SERVICE_NAME: &'static str = "foobar";
static DISPLAY_NAME: &'static str = "FooBar Service";
static DESCRIPTION: &'static str = "This is the FooBar service";

fn main() {
    let yaml = load_yaml!("cli.yml");
    let app = App::from_yaml(yaml);
    let matches = app.version(crate_version!()).get_matches();
    let cmd = matches.value_of("cmd").unwrap_or("").to_string();

    let mut controller = Controller::new(SERVICE_NAME, DISPLAY_NAME, DESCRIPTION);

    match cmd.as_str() {
        "create" => controller.create(),
        "delete" => controller.delete(),
        "start" => controller.start(),
        "stop" => controller.stop(),
        "standalone" => {
            let (tx, rx) = mpsc::channel();

            ctrlc::set_handler(move || {
                let _ = tx.send(ServiceEvent::Stop);
            }).expect("Failed to register Ctrl-C handler");

            my_service_main(rx, vec![], true);
        }
        _ => {
            let _result = controller.register(service_main_wrapper);
        }
    }
}

Dependencies

~1.6–10MB
~103K SLoC