IFEM-2/ControlFIFO_8h_source.html

// $Id$

//==============================================================================

//==============================================================================


#ifndef CONTROL_FIFO_H_

#define CONTROL_FIFO_H_


#include <string>

#include <map>


namespace tinyxml2 { class XMLElement; }


class ControlCallback

{

public:

  virtual void OnControl(const tinyxml2::XMLElement* context) = 0;

  virtual std::string GetContext() const = 0;

};


class ControlFIFO

{

public:

  ControlFIFO() : fifo(-1) {}


  ~ControlFIFO();


  void registerCallback(ControlCallback& callback);


  bool open(const char* name = "ifem-control");


  void poll();


private:

  std::string fifo_name;

  int         fifo;


  std::map<std::string,ControlCallback*> callbacks;

};


#endif

ControlCallback
Callback for FIFO option handling.
Definition ControlFIFO.h:28

ControlCallback::OnControl
virtual void OnControl(const tinyxml2::XMLElement *context)=0
Callback on receiving a XML control block.

ControlCallback::GetContext
virtual std::string GetContext() const =0
Returns context name for callback.

ControlFIFO
This class enables simple application control over a FIFO.
Definition ControlFIFO.h:45

ControlFIFO::fifo
int fifo
fifo handle
Definition ControlFIFO.h:66

ControlFIFO::ControlFIFO
ControlFIFO()
Default constructor.
Definition ControlFIFO.h:48

ControlFIFO::~ControlFIFO
~ControlFIFO()
The destructor tears down the opened fifo and removes the file.
Definition ControlFIFO.C:24

ControlFIFO::registerCallback
void registerCallback(ControlCallback &callback)
Registers a callback handler.
Definition ControlFIFO.C:80

ControlFIFO::poll
void poll()
Polls for new data in the fifo.
Definition ControlFIFO.C:51

ControlFIFO::fifo_name
std::string fifo_name
Name of filesystem entry of our fifo.
Definition ControlFIFO.h:65

ControlFIFO::open
bool open(const char *name="ifem-control")
Opens the fifo and prepares for receiving.
Definition ControlFIFO.C:34

ControlFIFO::callbacks
std::map< std::string, ControlCallback * > callbacks
Registered callbacks.
Definition ControlFIFO.h:68