fsfw/serviceinterface/ServiceInterfaceStream.h

#ifndef FRAMEWORK_SERVICEINTERFACE_SERVICEINTERFACESTREAM_H_
#define FRAMEWORK_SERVICEINTERFACE_SERVICEINTERFACESTREAM_H_

#include "ServiceInterfaceBuffer.h"
#include <FSFWConfig.h>

#if FSFW_CPP_OSTREAM_ENABLED == 1

#include <iostream>
#include <cstdio>

/**
 * Generic service interface stream which can be used like std::cout or
 * std::cerr but has additional capability. Add preamble and timestamp
 * to output. Can be run in buffered or unbuffered mode.
 */
class ServiceInterfaceStream : public std::ostream {
public:
	/**
	 * This constructor is used by specifying the preamble message.
	 * Optionally, the output can be directed to stderr and a CR character
	 * can be prepended to the preamble.
	 * @param setMessage message of preamble.
	 * @param addCrToPreamble Useful for applications like Puttty.
	 * @param buffered specify whether to use buffered mode.
	 * @param errStream specify which output stream to use (stderr or stdout).
	 */
	ServiceInterfaceStream(std::string setMessage,
			bool addCrToPreamble = false, bool buffered = true,
			bool errStream = false, uint16_t port = 1234);

	//! An inactive stream will not print anything.
	void setActive( bool );

	/**
	 * This can be used to retrieve the preamble in case it should be printed in
	 * the unbuffered mode.
	 * @return Preamle consisting of log message and timestamp.
	 */
	std::string* getPreamble();

	/**
	 * Can be used to determine if the stream was configured to add CR characters in addition
	 * to newline characters.
	 * @return
	 */
	bool crAdditionEnabled() const;

protected:
	ServiceInterfaceBuffer streambuf;
};

// Forward declaration of interface streams. These should be instantiated in
// main. They can then be used like std::cout or std::cerr.
namespace sif {
extern ServiceInterfaceStream debug;
extern ServiceInterfaceStream info;
extern ServiceInterfaceStream warning;
extern ServiceInterfaceStream error;
}

#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */

#endif /* FRAMEWORK_SERVICEINTERFACE_SERVICEINTERFACESTREAM_H_ */