fastlog.h

Go to the documentation of this file.

 
#include "elementa/license.inc"
#include "elementa/checks.inc"
 
#ifndef ELEMENTA_UTILS_COMMANDLINE
#define ELEMENTA_UTILS_COMMANDLINE
 
#include <chrono>
#include "elementa/base/serial_channels.h"
#include "elementa/base/threads.h"
#include "elementa/adts/circularbuffers.h"
 
 
namespace elementa
{
 
namespace utils
{
 
/* **********************************************************************
 
    Template class: FastLog
 
*************************************************************************/
 
 
template <typename Data>
class FastLog
{
 public:
 
    struct Datum
    {
        std::chrono::time_point<std::chrono::steady_clock> moment; 
        std::thread::id author; 
        Data data; 
    };
 
    FastLog(size_t capacity):log_{capacity} {}
    
    
    void clear(void);
    
    bool empty(void) const;
 
    size_t size(void) const;
    
    void add(const Data & data);
    
    void extract(Datum & ld);
        
    
 private:
 
    std::mutex logmtx_;
    elementa::adts::CircularBuffer<Datum> log_;
};
 
 
 
/* ===========================================================================
 
        ========== IMPLEMENTATION OF TEMPLATES ==========
 
============================================================================= */
 
 
/* ***************************************************************************
 
    Template class: FastLog
    
*******************************************************************************/
 
template <typename Data>
void FastLog<Data>::clear(void) 
{ 
    std::unique_lock<std::mutex> lock(logmtx_); 
 
    log_.clear(); 
}
 
template <typename Data>
bool FastLog<Data>::empty(void) const 
{ 
    std::unique_lock<std::mutex> lock(const_cast<std::mutex &>(logmtx_)); 
 
    return(log_.empty()); 
}
 
template <typename Data>
size_t FastLog<Data>::size(void) const 
{ 
    std::unique_lock<std::mutex> lock(const_cast<std::mutex &>(logmtx_)); 
 
    return(log_.size()); 
}
 
template <typename Data>
void FastLog<Data>::add(const Data & data)
{ 
    std::unique_lock<std::mutex> lock(logmtx_); 
    
    log_.push_back({std::chrono::steady_clock::now(),
                    std::this_thread::get_id(),
                    data});
}
 
 
template <typename Data>
void FastLog<Data>::extract(Datum & ld)
{
    std::unique_lock<std::mutex> lock(logmtx_); 
    
    ld = log_.front();
    log_.pop_front();
}
 
  // FastLog
 
} // End os namespace
 
} // End elementa namespace 
 
 
#endif