summaryrefslogtreecommitdiff
path: root/include/gras/top_block.hpp
diff options
context:
space:
mode:
authorJosh Blum2012-10-28 22:39:39 -0700
committerJosh Blum2012-10-28 22:39:39 -0700
commit77f79c8e2c45d816a2ecb869b2869825b3293640 (patch)
tree888dfa430241024e0dd47248aa14a8a09394d469 /include/gras/top_block.hpp
parent9620afa87986645653b171fb2c74c06597edb382 (diff)
downloadsandhi-77f79c8e2c45d816a2ecb869b2869825b3293640.tar.gz
sandhi-77f79c8e2c45d816a2ecb869b2869825b3293640.tar.bz2
sandhi-77f79c8e2c45d816a2ecb869b2869825b3293640.zip
work on stand-alone library build
Diffstat (limited to 'include/gras/top_block.hpp')
-rw-r--r--include/gras/top_block.hpp98
1 files changed, 98 insertions, 0 deletions
diff --git a/include/gras/top_block.hpp b/include/gras/top_block.hpp
new file mode 100644
index 0000000..8bf366f
--- /dev/null
+++ b/include/gras/top_block.hpp
@@ -0,0 +1,98 @@
+//
+// Copyright 2012 Josh Blum
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+#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 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)
+ void start(void);
+
+ //! Stop a flow graph execution (does not block)
+ 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);
+
+};
+
+} //namespace gras
+
+#endif /*INCLUDED_GRAS_TOP_BLOCK_HPP*/