Fawkes API Fawkes Development Version
thread_notification_listener.cpp
1
2/***************************************************************************
3 * thread_notification_listener.cpp - thread notification listener interface
4 *
5 * Created: Fri Jun 08 16:39:20 2007
6 * Copyright 2006-2007 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 <core/threading/thread_notification_listener.h>
25
26namespace fawkes {
27
28/** @class ThreadNotificationListener <core/threading/thread_notification_listener.h>
29 * Thread notification listener interface.
30 * A thread notification listener can be added to a thread to be notified of a
31 * successful startup of if the initialization fails (and hence the thread is
32 * never started).
33 *
34 * @author Tim Niemueller
35 *
36 * @fn bool ThreadNotificationListener::thread_started(Thread *thread) noexcept
37 * Thread started successfully.
38 * This is called by the thread itself when the thread started successfully.
39 * @param thread thread that started successfully
40 * @return true to stay registered for further thread notifications, false to
41 * unregister.
42 *
43 * @fn bool ThreadNotificationListener::thread_init_failed(Thread *thread) noexcept
44 * Thread initialization failed.
45 * This method is called by ThreadList if one of the threads in the list failed
46 * to initialize. This is not necessarily the thread that you registered the
47 * notification for. However, the argument is always the thread that you
48 * registered for, no matter which thread in the list failed.
49 * @param thread thread that you registered for
50 * @return true to stay registered for further thread notifications, false to
51 * unregister.
52 */
53
54/** Virtual empty destructor. */
56{
57}
58
59} // end namespace fawkes
virtual ~ThreadNotificationListener()
Virtual empty destructor.
Fawkes library namespace.