lyx_mirror/src/support/forkedcontr.h

85 lines
2.2 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file forkedcontr.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Asger Alstrup Nielsen
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS
*
* A class for the control of child processes launched using
* fork() and execvp().
*/
#ifndef FORKEDCONTR_H
#define FORKEDCONTR_H
#include "LString.h"
#include <boost/signals/signal0.hpp>
#include <boost/signals/trackable.hpp>
#include <sys/types.h> // needed for pid_t
#include <list>
#include <vector>
class ForkedProcess;
class Timeout;
class ForkedcallsController : public boost::signals::trackable {
public:
/// We need this to avoid warnings.
ForkedcallsController();
/** This d-tor should really be private, but making it public
* allows egcs 1.1 to compile the class.
*/
~ForkedcallsController();
/// Get hold of the only controller that can exist inside the process.
static ForkedcallsController & get();
/// Add a new child process to the list of controlled processes.
void addCall(ForkedProcess const &);
/** This method is connected to the timer. Every XX ms it is called
* so that we can check on the status of the children. Those that
* are found to have finished are removed from the list and their
* callback function is passed the final return state.
*/
void timer();
/// Return a vector of the pids of all the controlled processes.
std::vector<pid_t> const getPIDs() const;
/// Get the command string of the process.
string const getCommand(pid_t) const;
/** Kill this process prematurely and remove it from the list.
* The process is killed within tolerance secs.
* See forkedcall.[Ch] for details.
*/
void kill(pid_t, int tolerance = 5);
/// Signal emitted when the list of current child processes changes.
boost::signal0<void> childrenChanged;
private:
///
ForkedcallsController(ForkedcallsController const &);
/// The child processes
typedef std::list<ForkedProcess *> ListType;
///
ListType forkedCalls;
/** The timer. Enables us to check the status of the children
* every XX ms and to invoke a callback on completion.
*/
Timeout * timeout_;
};
#endif // FORKEDCONTR_H