Tools/Debugging/QueueFillRequest.h

Go to the documentation of this file.

/**
 * @file QueueFillRequest.h
 * Declaration of class QueueFillRequest.
 *
 * @author <a href=mailto:dueffert@informatik.hu-berlin.de>Uwe Düffert</a>
 */

#ifndef __QUEUEFILLREQUEST_H__
#define __QUEUEFILLREQUEST_H__

#include "Tools/Streams/InOut.h"

/**
 * @class QueueFillRequest
 * Request to fill DebugQueues with a certain QueueFillMode
 */
class QueueFillRequest
{
public:
  /** different modes for filling debug queues */
  typedef enum QueueFillMode{
    immediateReadWrite, 
    collectNSeconds, 
    toStickNSeconds, 
    overwriteOlder, 
    rejectAll, 
    toStickImmediately, 
    collect, 
    saveCollected, 
    sendCollected,
    blockNewMessages
  } QueueFillMode;
  
  /** Constructor */
  QueueFillRequest():mode(immediateReadWrite),seconds(0) {}

  /** Constructor
    * @param qfm The requested QueueFillMode.
    * @param sec Number of seconds to wait for in NSeconds modes.
    */
  QueueFillRequest(QueueFillMode qfm, long sec=1):mode(qfm),seconds(sec) {}

  /** requested mode for filling a DebugQueue */
  QueueFillMode mode;

  /** how many seconds shall we wait in collectNSeconds mode */
  long seconds;
};

/**
 * Streaming operator that reads a QueueFillRequest from a stream.
 * @param stream The stream from which is read.
 * @param queueFillRequest The QueueFillRequest object.
 * @return The stream.
 */ 
In& operator>>(In& stream,QueueFillRequest& queueFillRequest);
 
/**
 * Streaming operator that writes a QueueFillRequest to a stream.
 * @param stream The stream to write on.
 * @param queueFillRequest The QueueFillRequest object.
 * @return The stream.
 */ 
Out& operator<<(Out& stream, const QueueFillRequest& queueFillRequest);

#endif // __QUEUEFILLREQUEST_H__

---