sbit::mpscq::MessagePool< Payload > Class Template Reference

#include <mpscq.h>

Public Member Functions
	MessagePool (size_t allocationGroupSize, std::pmr::memory_resource *memoryResource)
Message *	allocate ()

Detailed Description

template<typename Payload>
class sbit::mpscq::MessagePool< Payload >

Efficient object pool for messages

Allocates objects in batches, using the passed-in memory resource.

Template Parameters

Payload

Is the type of the useful payload processed via the queue

Constructor & Destructor Documentation

MessagePool()

template<typename Payload >

sbit::mpscq::MessagePool< Payload >::MessagePool ( size_t  allocationGroupSize, std::pmr::memory_resource *  memoryResource  )

inline

Constructs a message pool

Parameters

allocationGroupSize	Specifies how many objects to allocate at once
memoryResource	Indicates the memory resource backing the allocations

Member Function Documentation

allocate()

template<typename Payload >

Message* sbit::mpscq::MessagePool< Payload >::allocate ( )

inline

Allocates a message

Returns

a pointer to the message

---

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

• /home/florin/work/mpscq/include/sbit/mpscq.h