mf::SingleConsumerQ Class Reference

#include <SingleConsumerQ.h>

Classes
struct	Buffer
struct	ConsumerType
class	OperateBuffer
struct	ProducerType

Public Types
using	ConsumerBuffer = OperateBuffer< ConsumerType >
using	ProducerBuffer = OperateBuffer< ProducerType >

Public Member Functions
	SingleConsumerQ (int const max_event_size, int const max_queue_depth)
Buffer	getProducerBuffer ()
void	releaseProducerBuffer (void *)
void	commitProducerBuffer (void *, int)
Buffer	getConsumerBuffer ()
void	releaseConsumerBuffer (void *)
void	commitConsumerBuffer (void *, int)
int	maxEventSize () const
int	maxQueueDepth () const
	SingleConsumerQ (SingleConsumerQ const &)=delete
SingleConsumerQ	operator= (SingleConsumerQ const &)=delete

Private Types
using	ByteArray = std::vector< char >
using	Pool = std::vector< void * >
using	Queue = std::vector< Buffer >

Private Attributes
int	max_event_size_
int	max_queue_depth_
int	pos_
ByteArray	mem_
Pool	buffer_pool_ {}
Queue	queue_
unsigned int	fpos_ {}
unsigned int	bpos_ {}
std::mutex	pool_mutex_ {}
std::mutex	queue_mutex_ {}
std::condition_variable	pool_cond_ {}
std::condition_variable	pop_cond_ {}
std::condition_variable	push_cond_ {}

Detailed Description

Definition at line 39 of file SingleConsumerQ.h.

Member Typedef Documentation

using mf::SingleConsumerQ::ByteArray = std::vector<char>

private

Definition at line 149 of file SingleConsumerQ.h.

using mf::SingleConsumerQ::ConsumerBuffer = OperateBuffer<ConsumerType>

Definition at line 122 of file SingleConsumerQ.h.

using mf::SingleConsumerQ::Pool = std::vector<void*>

private

Definition at line 151 of file SingleConsumerQ.h.

using mf::SingleConsumerQ::ProducerBuffer = OperateBuffer<ProducerType>

Definition at line 123 of file SingleConsumerQ.h.

using mf::SingleConsumerQ::Queue = std::vector<Buffer>

private

Definition at line 153 of file SingleConsumerQ.h.

Constructor & Destructor Documentation

mf::SingleConsumerQ::SingleConsumerQ	(	int const	max_event_size,
		int const	max_queue_depth
	)

Definition at line 5 of file SingleConsumerQ.cc.

    : max_event_size_(max_event_size)
    , max_queue_depth_(max_queue_depth)
    , pos_(max_queue_depth - 1)
    , mem_(max_event_size * max_queue_depth)
    , queue_(max_queue_depth)
  {
    // throw if event size 0 or queue depth 0

    for (char* i = &mem_[0]; i < &mem_[mem_.size()]; i += max_event_size)
      buffer_pool_.push_back(i);
  }

mf::SingleConsumerQ::SingleConsumerQ ( SingleConsumerQ const &  )

delete

Member Function Documentation

void mf::SingleConsumerQ::commitConsumerBuffer	(	void *	v,
		int
	)

Definition at line 89 of file SingleConsumerQ.cc.

  {
    releaseProducerBuffer(v);
  }

void mf::SingleConsumerQ::commitProducerBuffer	(	void *	v,
		int	len
	)

Definition at line 43 of file SingleConsumerQ.cc.

  {
    // get lock
    std::unique_lock<std::mutex> sl(queue_mutex_);
    // if full, wait for item to be removed
    while ((bpos_ + max_queue_depth_) == fpos_) {
      push_cond_.wait(sl);
    }

    // put buffer into queue
    queue_[fpos_ % max_queue_depth_] = Buffer(v, len);
    ++fpos_;
    // signal consumer
    pop_cond_.notify_all();
  }

SingleConsumerQ::Buffer mf::SingleConsumerQ::getConsumerBuffer

(

)

Definition at line 60 of file SingleConsumerQ.cc.

  {
    // get lock
    std::unique_lock<std::mutex> sl(queue_mutex_);
    // if empty, wait for item to appear
    while (bpos_ == fpos_) {
      pop_cond_.wait(sl);
    }
    // get a buffer from the queue and return it
    Buffer v = queue_[bpos_ % max_queue_depth_];
    ++bpos_;
    // note that these operations cannot throw
    // signal producer
    push_cond_.notify_all();
    return v;
  }

SingleConsumerQ::Buffer mf::SingleConsumerQ::getProducerBuffer

(

)

Definition at line 19 of file SingleConsumerQ.cc.

  {
    // get lock
    std::unique_lock<std::mutex> sl(pool_mutex_);
    // wait for buffer to appear
    while (pos_ < 0) {
      pool_cond_.wait(sl);
    }
    void* v = buffer_pool_[pos_];
    --pos_;
    return Buffer(v, max_event_size_);
  }

int mf::SingleConsumerQ::maxEventSize ( ) const

inline

Definition at line 134 of file SingleConsumerQ.h.

    {
      return max_event_size_;
    }

int mf::SingleConsumerQ::maxQueueDepth ( ) const

inline

Definition at line 139 of file SingleConsumerQ.h.

    {
      return max_queue_depth_;
    }

SingleConsumerQ mf::SingleConsumerQ::operator= ( SingleConsumerQ const &  )

delete

void mf::SingleConsumerQ::releaseConsumerBuffer

(

void *

v

)

Definition at line 78 of file SingleConsumerQ.cc.

  {
    // should the buffer be placed back onto the queue and not released?
    // we got here because a commit did to occur in the consumer.
    // we will allow consumers to call or not call commit for now, meaning
    // that we cannot distinguish between exception conditions and normal
    // return.  The buffer will always be released
    releaseProducerBuffer(v);
  }

void mf::SingleConsumerQ::releaseProducerBuffer

(

void *

v

)

Definition at line 33 of file SingleConsumerQ.cc.

  {
    // get lock
    std::lock_guard<std::mutex> sl(pool_mutex_);
    ++pos_;
    buffer_pool_[pos_] = v;
    pool_cond_.notify_all();
  }

Member Data Documentation

unsigned int mf::SingleConsumerQ::bpos_ {}

private

Definition at line 161 of file SingleConsumerQ.h.

Pool mf::SingleConsumerQ::buffer_pool_ {}

private

Definition at line 159 of file SingleConsumerQ.h.

unsigned int mf::SingleConsumerQ::fpos_ {}

private

Definition at line 161 of file SingleConsumerQ.h.

int mf::SingleConsumerQ::max_event_size_

private

Definition at line 155 of file SingleConsumerQ.h.

int mf::SingleConsumerQ::max_queue_depth_

private

Definition at line 156 of file SingleConsumerQ.h.

ByteArray mf::SingleConsumerQ::mem_

private

Definition at line 158 of file SingleConsumerQ.h.

std::condition_variable mf::SingleConsumerQ::pool_cond_ {}

private

Definition at line 165 of file SingleConsumerQ.h.

std::mutex mf::SingleConsumerQ::pool_mutex_ {}

private

Definition at line 163 of file SingleConsumerQ.h.

std::condition_variable mf::SingleConsumerQ::pop_cond_ {}

private

Definition at line 166 of file SingleConsumerQ.h.

int mf::SingleConsumerQ::pos_

private

Definition at line 157 of file SingleConsumerQ.h.

std::condition_variable mf::SingleConsumerQ::push_cond_ {}

private

Definition at line 167 of file SingleConsumerQ.h.

Queue mf::SingleConsumerQ::queue_

private

Definition at line 160 of file SingleConsumerQ.h.

std::mutex mf::SingleConsumerQ::queue_mutex_ {}

private

Definition at line 164 of file SingleConsumerQ.h.

---

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

• messagefacility/messagefacility/Utilities/SingleConsumerQ.h
• messagefacility/messagefacility/Utilities/SingleConsumerQ.cc