Fetching contributors…
Cannot retrieve contributors at this time
73 lines (56 sloc) 1.78 KB
// 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 TopBlock : HierBlock
{
TopBlock(void);
TopBlock(const std::string &name);
virtual ~TopBlock(void);
/*!
* Commit changes to the global configuration.
* Call this after modifying the global config.
* Commit config is called automatically by start/stop/run.
*/
void commit_config(void);
/*!
* 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);
/*!
* Query the flow graph for information.
* An external app will visualize the data.
* \param args the input query args
* \return formatted result of the query
*/
virtual std::string query(const std::string &args);
};
} //namespace gras
#endif /*INCLUDED_GRAS_TOP_BLOCK_HPP*/