src/common/abstractsignalwatcher.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <QMetaType>
  24 #include <QObject>
  25
  26 /**
  27  * Interface for watching external, asynchronous events like POSIX signals.
  28  *
  29  * Abstracts the platform-specific details away, since we're only interested
  30  * in the action to take.
  31  */
  32 class AbstractSignalWatcher : public QObject
  33 {
  34     Q_OBJECT
  35
  36 public:
  37     enum class Action
  38     {
  39         Reload,      ///< Configuration should be reloaded (e.g. SIGHUP)
  40         Terminate,   ///< Application should be terminated (e.g. SIGTERM)
  41         HandleCrash  ///< Application is crashing (e.g. SIGSEGV)
  42     };
  43
  44     using QObject::QObject;
  45
  46 signals:
  47     /// An event/signal was received and the given action should be taken
  48     void handleSignal(AbstractSignalWatcher::Action action);
  49 };
  50
  51 Q_DECLARE_METATYPE(AbstractSignalWatcher::Action)