sparta::statistics::StreamController Class Reference

Stream controller interface. One of these objects will be shared between the simulation's run controller, and the root-level StreamNode's sitting at the top of each one of the simulation's report hierarchies. More...

#include <StreamController.hpp>

Public Member Functions
void	startStreaming ()
void	processStreams ()
void	stopStreaming ()

Detailed Description

Stream controller interface. One of these objects will be shared between the simulation's run controller, and the root-level StreamNode's sitting at the top of each one of the simulation's report hierarchies.

Definition at line 14 of file StreamController.hpp.

Constructor & Destructor Documentation

~StreamController()

virtual sparta::statistics::StreamController::~StreamController ( )

inlinevirtual

Definition at line 17 of file StreamController.hpp.

Member Function Documentation

processStreams()

void sparta::statistics::StreamController::processStreams ( )

inline

Notify the controller that it is time to get all buffered SI data and send it out to the registered client(s). This will call your startStreaming_() method if the controller hasn't been started yet.

Definition at line 33 of file StreamController.hpp.

startStreaming()

void sparta::statistics::StreamController::startStreaming ( )

inline

Begin streaming, start consumer threads, etc. Has no effect if called more than once.

Definition at line 21 of file StreamController.hpp.

stopStreaming()

void sparta::statistics::StreamController::stopStreaming ( )

inline

Terminate streaming, stop consumer threads, etc. This will ask you to perform one last flush of any leftover data still in the buffer.

Definition at line 43 of file StreamController.hpp.

---

The documentation for this class was generated from the following file:

• /github/workspace/sparta/sparta/statistics/dispatch/streams/StreamController.hpp