construct/construct
Jason Volk 82482278fb construct: Handle SIGUSR2 to refresh slave. 2023-03-20 00:49:11 -07:00
..
.gitignore construct: Rename directory. 2018-02-22 14:30:11 -08:00
Makefile.am construct: Interpose IORING_SETUP_COOP_TASKRUN where supported. 2023-02-23 19:03:35 -08:00
README.md ircd: Add infrastructure to handle continuation notification after suspending. 2019-06-05 15:06:16 -07:00
console.cc modules/console: Improve bad command error format; improve subcommands display. 2023-02-22 16:04:12 -08:00
console.h construct: Add -silent option to also suppress console result output. 2023-02-02 18:51:03 -08:00
construct.cc construct: Support IORING_SETUP_SINGLE_ISSUER (Linux 6.0) 2023-03-19 20:02:17 -07:00
construct.h construct: Split homeserver into unit; move smoketest handler; fix -nomatrix. 2021-01-04 08:47:22 -08:00
homeserver.cc construct: Fix the conf rehash interface for SIGUSR1. 2023-03-19 22:21:27 -07:00
homeserver.h construct: Fix the conf rehash interface for SIGUSR1. 2023-03-19 22:21:27 -07:00
lgetopt.cc construct: Add STRINGS program options type support. 2020-04-24 16:39:51 -07:00
lgetopt.h construct: Add STRINGS program options type support. 2020-04-24 16:39:51 -07:00
signals.cc construct: Handle SIGUSR2 to refresh slave. 2023-03-20 00:49:11 -07:00
signals.h construct::signals: Clear signal set for shutdown; place dtor. 2020-05-10 03:02:25 -07:00

README.md

Construct Server

Construct is the executable running libircd. This application provides an interface for the server administrator to start, stop, configure and locally communicate with the daemon. It sets up an asio::io_service which is passed to libircd, then it sets up signal handling, and then it runs the ios event loop until commanded to exit.

This program executes in the foreground. It does not "daemonize" anymore with a fork() etc. You are free to use your shell to execute or move the program to the background, or simply use a tmux or screen. Construct will output the libircd log to stdout and stderr by default.

Signals

Construct handles certain POSIX signals and their behavior is documented below. Prolonged ownership of any specific signal handler is not taken by libircd; only out here in the construct executable. libircd only makes cooperative use of signals: registering and deregistering any handlers stackfully in such a way that it is no concern to users of the library.

  • Signal handling is accomplished through boost::asio's mechanism which installs a handler to intercept the signal's delivery and posts it to the event loop for execution at the next event slice. This is how signal safety is achieved. Furthermore, according to boost docs, when signals are used this way they can be compatible with windows environments.
SIGQUIT

A ctrl-\ to Construct will cleanly shut down the server. It will not generate a coredump.

SIGINT

A ctrl-c to Construct will bring up the command line console interface. It will not halt the daemon. Log messages will be suppressed while the console is waiting for input, but service is still continuing in the background.

SIGHUP

A "HangUP" to Construct is only relevant to the command line console, and signals it to close like an EOF. The legacy functionality for reloading server configuration et al is moved to SIGUSR1.

SIGUSR1

This signal commands the server to reload and refresh various aspects of its configuration and running state.

SIGCONT

This signal is used to notify the server that execution has resumed after an unexpected gap. We call ircd::cont() after receiving this signal. Examples for when the server benefits from calling ircd::cont() are: after a previous stop signal, debugging, or ACPI suspend and resume, etc.