tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added some more code documentation.

This commit is contained in:
Gunnar Beutner 2012-11-26 08:29:26 +01:00
parent d26af07e48
commit 8e687ea7fe
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/base/stdiostream.cpp
View File

@ -21,6 +21,13 @@
using namespace icinga; using namespace icinga;
/**
* Constructor for the StdioStream class.
*
* @param innerStream The inner stream.
* @param ownsStream Whether the new object owns the inner stream. If true
* the stream's destructor deletes the inner stream.
*/
StdioStream::StdioStream(iostream *innerStream, bool ownsStream) StdioStream::StdioStream(iostream *innerStream, bool ownsStream)
: m_InnerStream(innerStream), m_OwnsStream(ownsStream), : m_InnerStream(innerStream), m_OwnsStream(ownsStream),
m_ReadAheadBuffer(boost::make_shared<FIFO>()) m_ReadAheadBuffer(boost::make_shared<FIFO>())
@ -28,6 +35,9 @@ StdioStream::StdioStream(iostream *innerStream, bool ownsStream)
m_ReadAheadBuffer->Start(); m_ReadAheadBuffer->Start();
} }
/**
* Destructor for the StdioStream class.
*/
StdioStream::~StdioStream(void) StdioStream::~StdioStream(void)
{ {
m_ReadAheadBuffer->Close(); m_ReadAheadBuffer->Close();