Fawkes API Fawkes Development Version
employer.cpp
1
2/***************************************************************************
3 * employer.cpp - Fawkes main loop employer
4 *
5 * Created: Sat Aug 2 00:08:53 2008
6 * Copyright 2006-2009 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#include <aspect/mainloop/employer.h>
25
26namespace fawkes {
27
28/** @class MainLoopEmployer <aspect/mainloop/employer.h>
29 * Main loop employer
30 * The MainLoopEmployer calls the main loop for execution. It is usually
31 * implemented in the main program.
32 * @author Tim Niemueller
33 *
34 * @fn void MainLoopEmployer::set_mainloop_thread(fawkes::Thread *mainloop_thread)
35 * Set a new main loop.
36 * Set the main loop. An exception should be thrown if anything prevents this
37 * from happening successful.
38 * @param mainloop_thread new main loop thread. The caller of this method must
39 * ensure that the thread operates in wait-for-wakeup mode and executes the main
40 * loop as its loop() method (i.e. the thread must have a properly initialized
41 * MainLoopAspect).
42 */
43
44/** Virtual empty destructor. */
46{
47}
48
49} // end of namespace fawkes
virtual ~MainLoopEmployer()
Virtual empty destructor.
Definition: employer.cpp:45
Fawkes library namespace.