client-cpp  0.10.0
Public Member Functions | List of all members
kaa::LogBucket Class Reference

The helper class which is used to transfer logs from LogStorage to LogCollector. More...

#include <LogBucket.hpp>

Public Member Functions

 LogBucket ()
 Constructs empty LogBucket object. More...
 
 LogBucket (std::int32_t id, std::list< LogRecord > &&records)
 Constructs LogBucket object. More...
 
 LogBucket (std::int32_t id, const std::list< LogRecord > &records)
 Constructs LogBucket object. More...
 
std::int32_t getBucketId () const
 Returns a log bucket id. More...
 
std::list< LogRecord > & getRecords ()
 Returns log records of the bucket. More...
 

Detailed Description

The helper class which is used to transfer logs from LogStorage to LogCollector.

Note
The id should be unique across all available log buckets.

Definition at line 33 of file LogBucket.hpp.

Constructor & Destructor Documentation

kaa::LogBucket::LogBucket ( )
inline

Constructs empty LogBucket object.

Definition at line 39 of file LogBucket.hpp.

kaa::LogBucket::LogBucket ( std::int32_t  id,
std::list< LogRecord > &&  records 
)
inline

Constructs LogBucket object.

Parameters
[in]idThe unique log bucket id.
[in]recordsLog records.

Definition at line 47 of file LogBucket.hpp.

kaa::LogBucket::LogBucket ( std::int32_t  id,
const std::list< LogRecord > &  records 
)
inline

Constructs LogBucket object.

Parameters
[in]idThe unique log bucket id.
[in]recordsLog records.

Definition at line 56 of file LogBucket.hpp.

Member Function Documentation

std::int32_t kaa::LogBucket::getBucketId ( ) const
inline

Returns a log bucket id.

A log bucket id should be unique across all available buckets.

Returns
The log bucket id.

Definition at line 66 of file LogBucket.hpp.

std::list<LogRecord>& kaa::LogBucket::getRecords ( )
inline

Returns log records of the bucket.

Returns
The list of log records.

Definition at line 75 of file LogBucket.hpp.

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