Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_top_block_impl.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2008 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef INCLUDED_GR_TOP_BLOCK_IMPL_H
24 #define INCLUDED_GR_TOP_BLOCK_IMPL_H
25
26 #include <gr_scheduler.h>
27 #include <boost/thread.hpp>
28
29 typedef boost::mutex                    gr_mutex;       // FIXME move these elsewhere
30 typedef boost::lock_guard<boost::mutex> gr_lock_guard;
31
32 /*!
33  *\brief Abstract implementation details of gr_top_block
34  * \ingroup internal
35  *
36  * The actual implementation of gr_top_block. Separate class allows
37  * decoupling of changes from dependent classes.
38  *
39  */
40 class gr_top_block_impl
41 {
42 public:
43   gr_top_block_impl(gr_top_block *owner);
44   ~gr_top_block_impl();
45
46   // Create and start scheduler threads
47   void start();
48
49   // Signal scheduler threads to stop
50   void stop();
51
52   // Wait for scheduler threads to exit
53   void wait();
54
55   // Lock the top block to allow reconfiguration
56   void lock();
57
58   // Unlock the top block at end of reconfiguration
59   void unlock();
60
61   // Dump the flowgraph to stdout
62   void dump();
63   
64 protected:
65     
66   enum tb_state { IDLE, RUNNING };
67
68   gr_top_block                  *d_owner;
69   gr_flat_flowgraph_sptr         d_ffg;
70   gr_scheduler_sptr              d_scheduler;
71
72   gr_mutex                       d_mutex;       // protects d_state and d_lock_count
73   tb_state                       d_state;
74   int                            d_lock_count;
75   
76 private:
77   void restart();
78 };
79
80 #endif /* INCLUDED_GR_TOP_BLOCK_IMPL_H */