Package org.yamcs.utils

Class SDNotify

java.lang.Object

org.yamcs.utils.SDNotify

public class SDNotify
extends Object

Helper utility for sending systemd notification events about state changes.

The primary use case is to send a notification to the systemd notification when Yamcs has finished starting. This can be used when Yamcs runs as a service unit with Type=notify in its definition file.

See https://www.freedesktop.org/software/systemd/man/sd_notify.html

Constructor Summary

Constructors

Constructor	Description
SDNotify()

Method Summary

Modifier and Type	Method	Description
static boolean	isSupported()
static void	sendStartupNotification()	Tell the service manager that Yamcs has finished starting.
static void	sendStoppingNotification()	Tell the service manager that Yamcs is beginning its shutdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SDNotify

public SDNotify()

Method Details

sendStartupNotification

public static void sendStartupNotification()
                                    throws IOException

Tell the service manager that Yamcs has finished starting.

This method requires that isSupported() returns true.

Throws:

IOException

sendStoppingNotification

public static void sendStoppingNotification()

Tell the service manager that Yamcs is beginning its shutdown.

This method requires that isSupported() returns true.

isSupported

public static boolean isSupported()