Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_scheduler_tpb.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 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 along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 #ifndef INCLUDED_GR_SCHEDULER_TPB_H
22 #define INCLUDED_GR_SCHEDULER_TPB_H
23
24 #include <gr_scheduler.h>
25 #include <gruel/thread_group.h>
26
27 /*!
28  * \brief Concrete scheduler that uses a kernel thread-per-block
29  */
30 class gr_scheduler_tpb : public gr_scheduler
31 {
32   gruel::thread_group                  d_threads;
33
34 protected:
35   /*!
36    * \brief Construct a scheduler and begin evaluating the graph.
37    *
38    * The scheduler will continue running until all blocks until they
39    * report that they are done or the stop method is called.
40    */
41   gr_scheduler_tpb(gr_flat_flowgraph_sptr ffg);
42
43 public:
44   static gr_scheduler_sptr make(gr_flat_flowgraph_sptr ffg);
45
46   ~gr_scheduler_tpb();
47
48   /*!
49    * \brief Tell the scheduler to stop executing.
50    */
51   void stop();
52
53   /*!
54    * \brief Block until the graph is done.
55    */
56   void wait();
57 };
58
59
60 #endif /* INCLUDED_GR_SCHEDULER_TPB_H */