3 * Copyright 2008 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
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.
22 #ifndef INCLUDED_GR_SCHEDULER_H
23 #define INCLUDED_GR_SCHEDULER_H
25 #include <boost/utility.hpp>
27 #include <gr_flat_flowgraph.h>
31 typedef boost::shared_ptr<gr_scheduler> gr_scheduler_sptr;
35 * \brief Abstract scheduler that takes a flattened flow graph and runs it.
37 * Preconditions: details, buffers and buffer readers have been assigned.
39 class gr_scheduler : boost::noncopyable
44 * \brief Construct a scheduler and begin evaluating the graph.
46 * The scheduler will continue running until all blocks until they
47 * report that they are done or the stop method is called.
49 gr_scheduler(gr_flat_flowgraph_sptr ffg);
51 virtual ~gr_scheduler();
54 * \brief Tell the scheduler to stop executing.
56 virtual void stop() = 0;
59 * \brief Block until the graph is done.
61 virtual void wait() = 0;
64 #endif /* INCLUDED_GR_SCHEDULER_H */