summaryrefslogtreecommitdiff
path: root/gnuradio-runtime/lib/scheduler_tpb.h
blob: aa116d828b9d931e796e856bbff640754a421a93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/* -*- c++ -*- */
/*
 * Copyright 2008,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#ifndef INCLUDED_GR_SCHEDULER_TPB_H
#define INCLUDED_GR_SCHEDULER_TPB_H

#include "scheduler.h"
#include <gnuradio/api.h>
#include <gnuradio/thread/thread_group.h>

namespace gr {

/*!
 * \brief Concrete scheduler that uses a kernel thread-per-block
 */
class GR_RUNTIME_API scheduler_tpb : public scheduler
{
    gr::thread::thread_group d_threads;

protected:
    /*!
     * \brief Construct a scheduler and begin evaluating the graph.
     *
     * The scheduler will continue running until all blocks until they
     * report that they are done or the stop method is called.
     */
    scheduler_tpb(flat_flowgraph_sptr ffg, int max_noutput_items, bool catch_exceptions);

public:
    static scheduler_sptr make(flat_flowgraph_sptr ffg,
                               int max_noutput_items = 100000,
                               bool catch_exceptions = true);

    ~scheduler_tpb();

    /*!
     * \brief Tell the scheduler to stop executing.
     */
    void stop();

    /*!
     * \brief Block until the graph is done.
     */
    void wait();
};

} /* namespace gr */

#endif /* INCLUDED_GR_SCHEDULER_TPB_H */