The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Linux::Systemd::Daemon - Systemd daemon API

VERSION

version 1.172840

SYNOPSIS

  use Linux::Systemd::Daemon 'sd_ready';

  # program initialisation
  sd_ready;

  while (1) {
      sd_notify(watchdog => 1, status => 'Main loop running');
      # do something here
  }

  sd_notify(stopping => 1, status => 'Shutting down...');

DESCRIPTION

An XS wrapper for sd-daemon, the systemd daemon interface.

Exports one function, "sd_notify", by default. A variety of convenience functions are also available for import, either individually or with the :all tag.

For a fully featured example, see the perl-daemon script and perl-daemon.service examples in eg.

FUNCTIONS

sd_notify(@array_of_pairs)

The main function, exported by default. Takes a list of pairs and converts them to a string to be passed to the C function man:sd_notify(3)

e.g.

  sd_notify(ready => 1, status => 'Processing requests');

sd_watchdog()

Convenience function. Optional export.

sd_ready()

Convenience function. Optional export.

sd_stopping()

Convenience function. Optional export.

sd_reloading()

Convenience function. Optional export.

sd_status(Str $status_message)

Convenience function. Optional export.

SEE ALSO

https://www.freedesktop.org/software/systemd/man/sd-daemon.html

BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the web interface at https://github.com/ioanrogers/Linux-Systemd/issues.

AVAILABILITY

The project homepage is http://metacpan.org/release/Linux-Systemd-Journal/.

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see https://metacpan.org/module/Linux::Systemd/.

SOURCE

The development version is on github at https://github.com/ioanrogers/Linux-Systemd and may be cloned from git://github.com/ioanrogers/Linux-Systemd.git

AUTHOR

Ioan Rogers <ioanr@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Ioan Rogers.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.