ldas-tools-al 2.6.7
Loading...
Searching...
No Matches
anonymous_namespace{Log.cc}::Log::StreamFile Class Reference

#include <Log.hh>

Inheritance diagram for anonymous_namespace{Log.cc}::Log::StreamFile:
Inheritance graph
[legend]
Collaboration diagram for anonymous_namespace{Log.cc}::Log::StreamFile:
Collaboration graph
[legend]

Public Types

typedef boost::shared_ptr< StreamCBInterface > callback_type
typedef boost::shared_ptr< StreamCBInterface > callback_type

Public Member Functions

 StreamFile ()
 Constructor.
 StreamFile ()
 Constructor.
virtual ~StreamFile ()
 Destructor.
virtual ~StreamFile ()
 Destructor.
void ArchiveDirectory (const std::string &Value)
std::string ArchiveDirectory () const
void ArchiveDirectory (const std::string &Value)
std::string ArchiveDirectory () const
void FilenameExtension (const std::string &Value)
std::string FilenameExtension () const
void FilenameExtension (const std::string &Value)
std::string FilenameExtension () const
void FilenamePattern (const std::string &Value)
std::string FilenamePattern () const
void FilenamePattern (const std::string &Value)
std::string FilenamePattern () const
virtual void Close ()
 How to close the stream.
virtual void Close ()
 How to close the stream.
virtual bool IsOpen () const
 Return the open state of the stream.
virtual bool IsOpen () const
 Return the open state of the stream.
virtual void Open ()
 How to open the stream.
virtual void Open ()
 How to open the stream.
virtual void WriteMessage (const std::string &Message)
 How to open the stream.
virtual void WriteMessage (const std::string &Message)
 How to open the stream.
void Callback (callback_type CallbackCallback)
 Establish callback.
void Callback (callback_type CallbackCallback)
 Establish callback.
template<typename T>
std::ostream & operator<< (T a)
 Output to the stream.
template<typename T>
std::ostream & operator<< (T a)
 Output to the stream.

Protected Member Functions

virtual std::string archive_filename () const
virtual std::string archive_filename () const
INT_4U entries () const
INT_4U entries () const
virtual INT_4U entriesMax () const
virtual INT_4U entriesMax () const
virtual std::string filename () const
virtual std::string filename () const
virtual void rotate ()
 Rotate log files.
virtual void rotate ()
 Rotate log files.
virtual std::ostream & stream ()
 Gain access to the stream.
virtual std::ostream & stream ()
 Gain access to the stream.
void onClose ()
 Destructor.
void onClose ()
void onOpen ()
 Destructor.
void onOpen ()

Private Attributes

std::string archive_directory
std::string filename_extension
std::string filename_pattern
INT_4U rotate_bytes
INT_4U rotate_bytes_trigger
INT_4U rotate_entries
INT_4U rotate_entries_trigger
callback_type callback
 Callback storage.

Member Typedef Documentation

◆ callback_type [1/2]

typedef boost::shared_ptr< StreamCBInterface > LDASTools::AL::Log::StreamInterface::callback_type
inherited

◆ callback_type [2/2]

typedef boost::shared_ptr< StreamCBInterface > LDASTools::AL::Log::StreamInterface::callback_type
inherited

Constructor & Destructor Documentation

◆ StreamFile() [1/2]

LDASTools::AL::Log::StreamFile::StreamFile ( )

Constructor.

◆ StreamFile() [2/2]

LDASTools::AL::Log::StreamFile::StreamFile ( )

Constructor.

◆ ~StreamFile() [1/2]

LDASTools::AL::Log::StreamFile::~StreamFile ( )
virtual

Destructor.

◆ ~StreamFile() [2/2]

virtual LDASTools::AL::Log::StreamFile::~StreamFile ( )
virtual

Destructor.

Member Function Documentation

◆ archive_filename() [1/2]

std::string LDASTools::AL::Log::StreamFile::archive_filename ( ) const
protectedvirtual

◆ archive_filename() [2/2]

virtual std::string LDASTools::AL::Log::StreamFile::archive_filename ( ) const
protectedvirtual

◆ ArchiveDirectory() [1/4]

std::string LDASTools::AL::Log::StreamFile::ArchiveDirectory ( ) const
inline

◆ ArchiveDirectory() [2/4]

std::string LDASTools::AL::Log::StreamFile::ArchiveDirectory ( ) const

◆ ArchiveDirectory() [3/4]

void LDASTools::AL::Log::StreamFile::ArchiveDirectory ( const std::string & Value)
inline

◆ ArchiveDirectory() [4/4]

void LDASTools::AL::Log::StreamFile::ArchiveDirectory ( const std::string & Value)

◆ Callback() [1/2]

void LDASTools::AL::Log::StreamInterface::Callback ( callback_type Callback)
inlineinherited

Establish callback.

◆ Callback() [2/2]

void LDASTools::AL::Log::StreamInterface::Callback ( callback_type Callback)
inherited

Establish callback.

◆ Close() [1/2]

void LDASTools::AL::Log::StreamFile::Close ( )
virtual

How to close the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ Close() [2/2]

virtual void LDASTools::AL::Log::StreamFile::Close ( )
virtual

How to close the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ entries() [1/2]

INT_4U LDASTools::AL::Log::StreamFile::entries ( ) const
inlineprotected

◆ entries() [2/2]

INT_4U LDASTools::AL::Log::StreamFile::entries ( ) const
protected

◆ entriesMax() [1/2]

INT_4U LDASTools::AL::Log::StreamFile::entriesMax ( ) const
protectedvirtual

◆ entriesMax() [2/2]

virtual INT_4U LDASTools::AL::Log::StreamFile::entriesMax ( ) const
protectedvirtual

◆ filename() [1/2]

std::string LDASTools::AL::Log::StreamFile::filename ( ) const
protectedvirtual

◆ filename() [2/2]

virtual std::string LDASTools::AL::Log::StreamFile::filename ( ) const
protectedvirtual

◆ FilenameExtension() [1/4]

std::string LDASTools::AL::Log::StreamFile::FilenameExtension ( ) const
inline

◆ FilenameExtension() [2/4]

std::string LDASTools::AL::Log::StreamFile::FilenameExtension ( ) const

◆ FilenameExtension() [3/4]

void LDASTools::AL::Log::StreamFile::FilenameExtension ( const std::string & Value)
inline

◆ FilenameExtension() [4/4]

void LDASTools::AL::Log::StreamFile::FilenameExtension ( const std::string & Value)

◆ FilenamePattern() [1/4]

std::string LDASTools::AL::Log::StreamFile::FilenamePattern ( ) const
inline

◆ FilenamePattern() [2/4]

std::string LDASTools::AL::Log::StreamFile::FilenamePattern ( ) const

◆ FilenamePattern() [3/4]

void LDASTools::AL::Log::StreamFile::FilenamePattern ( const std::string & Value)
inline

◆ FilenamePattern() [4/4]

void LDASTools::AL::Log::StreamFile::FilenamePattern ( const std::string & Value)

◆ IsOpen() [1/2]

bool LDASTools::AL::Log::StreamFile::IsOpen ( ) const
virtual

Return the open state of the stream.

Resturn the open state of the stream.

Returns
If the stream is open and writable, then return true. Otherwise, false.

Implements LDASTools::AL::Log::StreamInterface.

◆ IsOpen() [2/2]

virtual bool LDASTools::AL::Log::StreamFile::IsOpen ( ) const
virtual

Return the open state of the stream.

Returns
If the stream is open and writable, then return true. Otherwise, false.

Implements LDASTools::AL::Log::StreamInterface.

◆ onClose() [1/2]

void LDASTools::AL::Log::StreamInterface::onClose ( )
protectedinherited

Destructor.

◆ onClose() [2/2]

void LDASTools::AL::Log::StreamInterface::onClose ( )
protectedinherited

◆ onOpen() [1/2]

void LDASTools::AL::Log::StreamInterface::onOpen ( )
protectedinherited

Destructor.

◆ onOpen() [2/2]

void LDASTools::AL::Log::StreamInterface::onOpen ( )
protectedinherited

◆ Open() [1/2]

void LDASTools::AL::Log::StreamFile::Open ( )
virtual

How to open the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ Open() [2/2]

virtual void LDASTools::AL::Log::StreamFile::Open ( )
virtual

How to open the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ operator<<() [1/2]

template<typename T>
std::ostream & LDASTools::AL::Log::StreamInterface::operator<< ( T a)
inlineinherited

Output to the stream.

◆ operator<<() [2/2]

template<typename T>
std::ostream & LDASTools::AL::Log::StreamInterface::operator<< ( T a)
inlineinherited

Output to the stream.

◆ rotate() [1/2]

void LDASTools::AL::Log::StreamFile::rotate ( )
protectedvirtual

Rotate log files.

Todo
Rotate the logs

◆ rotate() [2/2]

virtual void LDASTools::AL::Log::StreamFile::rotate ( )
protectedvirtual

Rotate log files.

◆ stream() [1/2]

std::ostream & LDASTools::AL::Log::StreamFile::stream ( )
protectedvirtual

Gain access to the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ stream() [2/2]

virtual std::ostream & LDASTools::AL::Log::StreamFile::stream ( )
protectedvirtual

Gain access to the stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ WriteMessage() [1/2]

void LDASTools::AL::Log::StreamFile::WriteMessage ( const std::string & Message)
virtual

How to open the stream.

Parameters
[in]MessageThe message to send to the output stream.

Implements LDASTools::AL::Log::StreamInterface.

◆ WriteMessage() [2/2]

virtual void LDASTools::AL::Log::StreamFile::WriteMessage ( const std::string & Message)
virtual

How to open the stream.

Parameters
[in]MessageThe message to send to the output stream.

Implements LDASTools::AL::Log::StreamInterface.

Member Data Documentation

◆ archive_directory

std::string LDASTools::AL::Log::StreamFile::archive_directory
private

◆ callback

callback_type LDASTools::AL::Log::StreamInterface::callback
privateinherited

Callback storage.

If this is set, then this instance is called to handle additional actions that should happen when the stream is opened or closed.

◆ filename_extension

std::string LDASTools::AL::Log::StreamFile::filename_extension
private

◆ filename_pattern

std::string LDASTools::AL::Log::StreamFile::filename_pattern
private

◆ rotate_bytes

INT_4U LDASTools::AL::Log::StreamFile::rotate_bytes
private

◆ rotate_bytes_trigger

INT_4U LDASTools::AL::Log::StreamFile::rotate_bytes_trigger
private

◆ rotate_entries

INT_4U LDASTools::AL::Log::StreamFile::rotate_entries
private

◆ rotate_entries_trigger

INT_4U LDASTools::AL::Log::StreamFile::rotate_entries_trigger
private
The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/Log.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Log.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/Log.cc