libreoffice-online/common/SigUtil.hpp
Michael Meeks 333f8994e9 Cleanup shutdown flag handling.
Pull the notification pieces out of SigUtil.cpp - not signal safe,
and invoked only from LOOLWSD anyway.

In a non-blocking world, the socket close notification sends are
instant - so more work required to count-down / timeout remaining
clients.
2017-03-10 10:47:42 +01:00

63 lines
1.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_SIGNALUTIL_HPP
#define INCLUDED_SIGNALUTIL_HPP
#include <atomic>
#include <mutex>
/// Flag to commence clean shutdown
extern std::atomic<bool> ShutdownRequestFlag;
/// Flag to stop pump loops.
extern std::atomic<bool> TerminationFlag;
/// Flag to dump internal state
extern std::atomic<bool> DumpGlobalState;
/// Mutex to trap signal handler, if any,
/// and prevent _Exit while collecting backtrace.
extern std::mutex SigHandlerTrap;
namespace SigUtil
{
/// Returns the name of the signal.
const char* signalName(int signo);
/// Register a wakeup function when changing
/// Trap signals to cleanup and exit the process gracefully.
void setTerminationSignals();
/// Trap all fatal signals to assist debugging.
void setFatalSignals();
/// Trap generally useful signals
void setUserSignals();
/// Requests the server to initiate graceful shutdown.
/// Shutting down is a multi-stage process, because
/// it can be requested via signals.
/// Since we need to notify clients, we can't
/// invoke the sockets while in a signal handler.
/// This flags the server to notify clients first
/// then flags for shutdown.
void requestShutdown();
/// Kills a child process and returns true when
/// child pid is removed from the process table
/// after a certain (short) timeout.
bool killChild(const int pid);
} // end namespace SigUtil
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */