torsignal.h

Go to the documentation of this file.
00001 /****************************************************************
00002  *  Vidalia is distributed under the following license:
00003  *
00004  *  Copyright (C) 2006,  Matt Edman, Justin Hipple
00005  *
00006  *  This program is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU General Public License
00008  *  as published by the Free Software Foundation; either version 2
00009  *  of the License, or (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  * 
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, 
00019  *  Boston, MA  02110-1301, USA.
00020  ****************************************************************/
00021 
00022 /**
00023  * \file torsignal.h
00024  * \version $Id: torsignal.h 1563 2006-12-26 06:06:04Z edmanm $
00025  * \brief Sends a signal to Tor's control interface
00026  */
00027 
00028 #ifndef _TORSIGNAL_H
00029 #define _TORSGINAL_H
00030 
00031 #include <QString>
00032 
00033 
00034 class TorSignal
00035 {
00036 public:
00037   /** Signals that can be sent by the controller */
00038   enum Signal {
00039     Reload,   /**< SIGHUP: Reloads config items and refetch directory */
00040     Shutdown, /**< SIGINT: Controlled shutdown */
00041     Dump,     /**< SIGUSR1: Log information about current circuits */
00042     Debug,    /**< SIGUSR2: Switch all open logs to loglevel debug */
00043     Halt,     /**< SIGTERM: Immediate shutdown */
00044     NewNym    /**< NEWNYM: Switch to all new clean circuits */
00045   };
00046   
00047   /** Returns a string representation of a signal that Tor understands. */
00048   static QString toString(Signal signal);
00049 };
00050 
00051 #endif
00052 

Generated on Wed Sep 5 15:49:28 2007 for Vidalia by  doxygen 1.5.3