libreoffice-online/common/SigUtil.hpp
Tor Lillqvist 4eb598711c Use #pragma once
LibreOffice core uses that, too, and we support an even more
restricted set of compilers.

Change-Id: I0d0e2c8608e323eb5ef0f35ee8c46d02ab49a745
Reviewed-on: https://gerrit.libreoffice.org/c/online/+/92467
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Tor Lillqvist <tml@collabora.com>
2020-04-18 15:00:18 +02:00

85 lines
2.4 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/.
*/
#pragma once
#include <atomic>
#include <mutex>
#if MOBILEAPP
static constexpr bool ShutdownRequestFlag(false);
extern std::atomic<bool> MobileTerminationFlag;
#endif
namespace SigUtil
{
/// Get the flag used to commence clean shutdown.
/// requestShutdown() is used to set the flag.
bool getShutdownRequestFlag();
/// Get the flag to stop pump loops forcefully.
bool getTerminationFlag();
/// Set the flag to stop pump loops forcefully.
void setTerminationFlag();
#if MOBILEAPP
/// Reset the flag to stop pump loops forcefully.
/// Only necessary in Mobile.
void resetTerminationFlag();
#endif
/// Get the flag to dump internal state.
bool getDumpGlobalState();
/// Reset the flag to dump internal state.
void resetDumpGlobalState();
#if !MOBILEAPP
/// Wait for the signal handler, if any,
/// and prevent _Exit while collecting backtrace.
void waitSigHandlerTrap();
/// 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();
/// Trap to unpause the process
void setDebuggerSignal();
/// 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);
/// Dump a signal-safe back-trace
void dumpBacktrace();
#endif // !MOBILEAPP
} // end namespace SigUtil
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */