blob: 34ee98d61e033cac524c12c0656320458aa092ba (
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
// Copyright (C) by Josh Blum. See LICENSE.txt for licensing information.
#ifndef INCLUDED_GRAS_TOP_BLOCK_HPP
#define INCLUDED_GRAS_TOP_BLOCK_HPP
#include <gras/hier_block.hpp>
namespace gras
{
struct GRAS_API GlobalBlockConfig
{
GlobalBlockConfig(void);
/*!
* Constrain the maximum number of items that
* work can be called with for all output ports.
*
* Default = 0 aka disabled.
*/
size_t maximum_output_items;
/*!
* Set the global memory node affinity.
* Blocks that have not been explicitly set,
* will take on this new buffer_affinity.
*
* Default = -1 aka no affinity.
*/
long buffer_affinity;
};
struct GRAS_API TopBlock : HierBlock
{
TopBlock(void);
TopBlock(const std::string &name);
//! Get the global block config settings
GlobalBlockConfig get_global_config(void) const;
//! Set the global block config settings
void set_global_config(const GlobalBlockConfig &config);
/*!
* Commit changes to the overall flow graph.
* Call this after modifying connections.
* Commit is called automatically by start/stop/run.
*/
void commit(void);
/*!
* Run is for finite flow graph executions.
* Mostly for testing purposes only.
*/
void run(void);
//! Start a flow graph execution (does not block)
virtual void start(void);
//! Stop a flow graph execution (does not block)
virtual void stop(void);
/*!
* Wait for threads to exit after stop() or run().
* This is a blocking call and will not return until
* all blocks in the topology have been marked done.
*/
virtual void wait(void);
/*!
* Wait for threads to exit after stop() or run().
* This is call will block until timeout or done.
*
* \param timeout the timeout in seconds
* \return true of execution completed
*/
virtual bool wait(const double timeout);
/*!
* Get block usage statistics in XML format.
* An external app will visualize the data.
*/
virtual std::string get_stats_xml(void);
};
} //namespace gras
#endif /*INCLUDED_GRAS_TOP_BLOCK_HPP*/
|
