Merge commit 'v3.3.0' into upstream
[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 <gruel/thread.h>
28
29 /*!
30  *\brief Abstract implementation details of gr_top_block
31  * \ingroup internal
32  *
33  * The actual implementation of gr_top_block. Separate class allows
34  * decoupling of changes from dependent classes.
35  *
36  */
37 class gr_top_block_impl
38 {
39 public:
40   gr_top_block_impl(gr_top_block *owner);
41   ~gr_top_block_impl();
42
43   // Create and start scheduler threads
44   void start();
45
46   // Signal scheduler threads to stop
47   void stop();
48
49   // Wait for scheduler threads to exit
50   void wait();
51
52   // Lock the top block to allow reconfiguration
53   void lock();
54
55   // Unlock the top block at end of reconfiguration
56   void unlock();
57
58   // Dump the flowgraph to stdout
59   void dump();
60   
61 protected:
62     
63   enum tb_state { IDLE, RUNNING };
64
65   gr_top_block                  *d_owner;
66   gr_flat_flowgraph_sptr         d_ffg;
67   gr_scheduler_sptr              d_scheduler;
68
69   gruel::mutex                   d_mutex;       // protects d_state and d_lock_count
70   tb_state                       d_state;
71   int                            d_lock_count;
72   
73 private:
74   void restart();
75 };
76
77 #endif /* INCLUDED_GR_TOP_BLOCK_IMPL_H */