client-cpp  0.10.0
kaa::BucketInfo Class Reference

Describes a unique log bucket. More...

#include <BucketInfo.hpp>

Public Member Functions

 BucketInfo ()
 Constructs an empty BucketInfo object. More...
 
 BucketInfo (std::int32_t bucketId, std::size_t logCount)
 Constructs the BucketInfo object which contains a useful information about a log bucket. More...
 
std::int32_t getBucketId () const
 Returns the id of a bucket. More...
 
std::size_t getLogCount () const
 
bool operator< (const BucketInfo &info) const
 
bool operator== (const BucketInfo &info) const
 
bool operator!= (const BucketInfo &info) const
 

Detailed Description

Describes a unique log bucket.

By uniqueness it means that any of log records in a bucket is not repeated in any other log bucket.

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

Definition at line 31 of file BucketInfo.hpp.

Constructor & Destructor Documentation

kaa::BucketInfo::BucketInfo ( )
inline

Constructs an empty BucketInfo object.

Definition at line 36 of file BucketInfo.hpp.

kaa::BucketInfo::BucketInfo ( std::int32_t  bucketId,
std::size_t  logCount 
)
inline

Constructs the BucketInfo object which contains a useful information about a log bucket.

Parameters
[in]bucketIdThe id of a bucket.
Note
The id should be unique across all available log buckets.
Parameters
[in]logCountThe number of logs the bucket contains.

Definition at line 44 of file BucketInfo.hpp.

Member Function Documentation

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

Returns the id of a bucket.

Note
The id should be unique across all available log buckets.
Returns
The id of a bucket.

Definition at line 54 of file BucketInfo.hpp.

std::size_t kaa::BucketInfo::getLogCount ( ) const
inline
Returns
The number of logs a bucket contains.

Definition at line 61 of file BucketInfo.hpp.

bool kaa::BucketInfo::operator!= ( const BucketInfo info) const
inline

Definition at line 73 of file BucketInfo.hpp.

bool kaa::BucketInfo::operator< ( const BucketInfo info) const
inline

Definition at line 65 of file BucketInfo.hpp.

bool kaa::BucketInfo::operator== ( const BucketInfo info) const
inline

Definition at line 69 of file BucketInfo.hpp.


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