LibSgfcPlusPlus::SgfcMessageStream Class Reference

The SgfcMessageStream class captures the stream of messages that is generated by SGFC. More...

#include <SgfcMessageStream.h>

Public Member Functions
	SgfcMessageStream ()
	Initializes a newly constructed SgfcMessageStream object. The object immediately starts capturing the SGFC message stream.
virtual	~SgfcMessageStream ()
	Destroys and cleans up the SgfcMessageStream object.
std::vector< std::shared_ptr< ISgfcMessage > >	GetMessagees () const
	Returns a collection of messages captured so far by the SgfcMessageStream object. The messages appear in the collection in the order in which they are generated by SGFC. The collection is empty if SGFC has not generated any messages.

Detailed Description

The SgfcMessageStream class captures the stream of messages that is generated by SGFC.

SgfcMessageStream starts to capture the stream of SGFC messages immediately upon construction. Capturing stops only when the SgfcMessageStream object is destroyed. A client can access the messages captured so far during the lifetime of the SgfcMessageStream object by invoking its GetMessages() method.

Only one SgfcMessageStream can be active at any given time.

Constructor & Destructor Documentation

SgfcMessageStream()

LibSgfcPlusPlus::SgfcMessageStream::SgfcMessageStream

(

)

Initializes a newly constructed SgfcMessageStream object. The object immediately starts capturing the SGFC message stream.

Exceptions

std::logic_error

Is thrown if another SgfcMessageStream object already exists.

---

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

• /Users/patrick/dev/libsgfcplusplus/src/sgfc/message/SgfcMessageStream.h
• /Users/patrick/dev/libsgfcplusplus/src/sgfc/message/SgfcMessageStream.cpp