GNU Radio 3.6.3 C++ API
gr_scheduler_sts.h
Go to the documentation of this file.
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_STS_H
22 #define INCLUDED_GR_SCHEDULER_STS_H
23 
24 #include <gr_core_api.h>
25 #include <gr_scheduler.h>
26 #include <gruel/thread_group.h>
27 
28 /*!
29  * \brief Concrete scheduler that uses the single_threaded_scheduler
30  */
32 {
33  gruel::thread_group d_threads;
34 
35 protected:
36  /*!
37  * \brief Construct a scheduler and begin evaluating the graph.
38  *
39  * The scheduler will continue running until all blocks until they
40  * report that they are done or the stop method is called.
41  */
42  gr_scheduler_sts(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
43 
44 public:
45  static gr_scheduler_sptr make(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
46 
48 
49  /*!
50  * \brief Tell the scheduler to stop executing.
51  */
52  void stop();
53 
54  /*!
55  * \brief Block until the graph is done.
56  */
57  void wait();
58 };
59 
60 
61 
62 
63 #endif /* INCLUDED_GR_SCHEDULER_STS_H */