BufferManager Class Reference

#include <BufferManager.hpp>

Inheritance diagram for BufferManager:

Public Member Functions
	BufferManager (unsigned int numberOfBuffers=5, unsigned int maxPacketSize=4096)
	~BufferManager ()
IPacketBufferPtr	Reserve (unsigned int requestedSize, unsigned int &reservedSize) override
void	Reset ()
void	Commit (IPacketBufferPtr &packetBuffer, unsigned int size, bool notifyConsumer=true) override
void	Release (IPacketBufferPtr &packetBuffer) override
IPacketBufferPtr	GetReadableBuffer () override
void	MarkRead (IPacketBufferPtr &packetBuffer) override
void	SetConsumer (IConsumer *consumer) override
	Set Consumer on the buffer manager to be notified when there is a Commit Can only be one consumer. More...
void	FlushReadList () override
	Notify the Consumer buffer can be read. More...
Public Member Functions inherited from IBufferManager
virtual	~IBufferManager ()

Detailed Description

Definition at line 21 of file BufferManager.hpp.

Constructor & Destructor Documentation

BufferManager()

BufferManager	(	unsigned int	numberOfBuffers = 5,
		unsigned int	maxPacketSize = 4096
	)

Definition at line 15 of file BufferManager.cpp.

    : m_MaxBufferSize(maxPacketSize),
      m_NumberOfBuffers(numberOfBuffers)
{
    Initialize();
}

~BufferManager()

~BufferManager ( )

inline

Definition at line 26 of file BufferManager.hpp.

References BufferManager::Commit(), BufferManager::FlushReadList(), BufferManager::GetReadableBuffer(), BufferManager::MarkRead(), BufferManager::Release(), BufferManager::Reserve(), BufferManager::Reset(), and BufferManager::SetConsumer().

{}

Member Function Documentation

Commit()

void Commit ( IPacketBufferPtr &  packetBuffer, unsigned int  size, bool  notifyConsumer = true  )

overridevirtual

Implements IBufferManager.

Definition at line 43 of file BufferManager.cpp.

References BufferManager::FlushReadList().

Referenced by BOOST_AUTO_TEST_CASE(), and BufferManager::~BufferManager().

{
    std::unique_lock<std::mutex> readableListLock(m_ReadableMutex, std::defer_lock);
    packetBuffer->Commit(size);
    readableListLock.lock();
    m_ReadableList.push_back(std::move(packetBuffer));
    readableListLock.unlock();

    if (notifyConsumer)
    {
        FlushReadList();
    }
}

FlushReadList()

void FlushReadList ( )

overridevirtual

Notify the Consumer buffer can be read.

Implements IBufferManager.

Definition at line 116 of file BufferManager.cpp.

References IConsumer::SetReadyToRead().

Referenced by BufferManager::Commit(), and BufferManager::~BufferManager().

{
    // notify consumer that packet is ready to read
    if (m_Consumer != nullptr)
    {
        m_Consumer->SetReadyToRead();
    }
}

GetReadableBuffer()

IPacketBufferPtr GetReadableBuffer ( )

overridevirtual

Implements IBufferManager.

Definition at line 89 of file BufferManager.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), VerifyPostOptimisationStructureTestImpl(), and BufferManager::~BufferManager().

{
    std::unique_lock<std::mutex> readableListLock(m_ReadableMutex);
    if (!m_ReadableList.empty())
    {
        IPacketBufferPtr buffer = std::move(m_ReadableList.back());
        m_ReadableList.pop_back();
        readableListLock.unlock();
        return buffer;
    }
    return nullptr;
}

MarkRead()

void MarkRead ( IPacketBufferPtr &  packetBuffer )

overridevirtual

Implements IBufferManager.

Definition at line 102 of file BufferManager.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), VerifyPostOptimisationStructureTestImpl(), and BufferManager::~BufferManager().

{
    std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock);
    packetBuffer->MarkRead();
    availableListLock.lock();
    m_AvailableList.push_back(std::move(packetBuffer));
    availableListLock.unlock();
}

Release()

void Release ( IPacketBufferPtr &  packetBuffer )

overridevirtual

Implements IBufferManager.

Definition at line 68 of file BufferManager.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and BufferManager::~BufferManager().

{
    std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock);
    packetBuffer->Release();
    availableListLock.lock();
    m_AvailableList.push_back(std::move(packetBuffer));
    availableListLock.unlock();
}

Reserve()

IPacketBufferPtr Reserve ( unsigned int  requestedSize, unsigned int &  reservedSize  )

overridevirtual

Implements IBufferManager.

Definition at line 22 of file BufferManager.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and BufferManager::~BufferManager().

{
    reservedSize = 0;
    std::unique_lock<std::mutex> availableListLock(m_AvailableMutex, std::defer_lock);
    if (requestedSize > m_MaxBufferSize)
    {
        return nullptr;
    }
    availableListLock.lock();
    if (m_AvailableList.empty())
    {
        availableListLock.unlock();
        return nullptr;
    }
    IPacketBufferPtr buffer = std::move(m_AvailableList.back());
    m_AvailableList.pop_back();
    availableListLock.unlock();
    reservedSize = requestedSize;
    return buffer;
}

Reset()

void Reset

(

)

Definition at line 77 of file BufferManager.cpp.

Referenced by ProfilingService::GetSendTimelinePacket(), and BufferManager::~BufferManager().

{
    //This method should only be called once all threads have been joined
    std::lock_guard<std::mutex> readableListLock(m_ReadableMutex);
    std::lock_guard<std::mutex> availableListLock(m_AvailableMutex);

    m_AvailableList.clear();
    m_ReadableList.clear();

    Initialize();
}

SetConsumer()

void SetConsumer ( IConsumer *  consumer )

overridevirtual

Set Consumer on the buffer manager to be notified when there is a Commit Can only be one consumer.

Implements IBufferManager.

Definition at line 111 of file BufferManager.cpp.

Referenced by BufferManager::~BufferManager().

{
    m_Consumer = consumer;
}

---

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

• src/profiling/BufferManager.hpp
• src/profiling/BufferManager.cpp