Fawkes API  Fawkes Development Version
writer_listener.cpp
1 
2 /***************************************************************************
3  * writer_listener.cpp - Sync Writer Interface Listener
4  *
5  * Created: Fri Jun 05 16:16:22 2009
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.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #include "writer_listener.h"
24 #include "sync_thread.h"
25 
26 #include <blackboard/blackboard.h>
27 #include <logging/logger.h>
28 
29 using namespace fawkes;
30 
31 /** @class SyncWriterInterfaceListener "writer_listener.h"
32  * Listener for writer events in bbsync plugin.
33  * This class provides an adapter which reacts to writer events for a given
34  * number of (reading) interfaces. Note that the listener is <i>not</i>
35  * automatically registered, this has to be done from the outside.
36  * @author Tim Niemueller
37  */
38 
39 /** Constructor.
40  * @param sync_thread parent sync thread to sent events to
41  * @param logger logger for informational output
42  * @param desc description for this interface combination
43  */
45  fawkes::Logger *logger,
46  const char *desc)
47  : BlackBoardInterfaceListener("SyncWriterInterfaceListener(%s)", desc)
48 {
49  __logger = logger;
50  __sync_thread = sync_thread;
51 }
52 
53 
54 /** Add an interface to listen to.
55  * @param interface interface to listen to for writer events
56  */
57 void
59 {
60  bbil_add_writer_interface(interface);
61 }
62 
63 
64 /** Remove an interface to listen to.
65  * @param interface interface not to listen any longer for writer events
66  */
67 void
69 {
71 }
72 
73 void
75  unsigned int instance_serial) throw()
76 {
77  __sync_thread->writer_added(interface);
78 }
79 
80 
81 void
83  unsigned int instance_serial) throw()
84 {
85  __sync_thread->writer_removed(interface);
86 }
Fawkes library namespace.
void bbil_add_writer_interface(Interface *interface)
Add an interface to the writer addition/removal watch list.
Base class for all Fawkes BlackBoard interfaces.
Definition: interface.h:79
void bbil_remove_writer_interface(Interface *interface)
Remove an interface to the writer addition/removal watch list.
virtual void bb_interface_writer_removed(fawkes::Interface *interface, unsigned int instance_serial)
A writing instance has been closed for a watched interface.
SyncWriterInterfaceListener(BlackBoardSynchronizationThread *sync_thread, fawkes::Logger *logger, const char *desc)
Constructor.
void remove_interface(fawkes::Interface *interface)
Remove an interface to listen to.
void add_interface(fawkes::Interface *interface)
Add an interface to listen to.
Thread to synchronize two BlackBoards.
Definition: sync_thread.h:44
virtual void bb_interface_writer_added(fawkes::Interface *interface, unsigned int instance_serial)
A writing instance has been opened for a watched interface.
void writer_added(fawkes::Interface *interface)
A writer has been added for an interface.
void writer_removed(fawkes::Interface *interface)
A writer has been removed for an interface.
BlackBoard interface listener.
Interface for logging.
Definition: logger.h:34