Template Class CInProcMemBuffer

• Defined in File in_process_mem_buffer.h

Nested Relationships

Nested Types

• Struct CInProcMemBuffer::SSync

Inheritance Relationships

Base Type

• public TAccessor

Class Documentation

template<class TAccessor>
class CInProcMemBuffer : public TAccessor

In-process memory buffer.

Public Functions

inline CInProcMemBuffer(uint32_t uiSize = 1048576)

Default constructor.

Parameters:

uiSize – [in] Size of the buffer (default is 1 MByte). Must not be zero.

inline CInProcMemBuffer(const std::string &rssConnectionString)

Connection constructor.

Parameters:

rssConnectionString – [in] Reference to string with connection information.

~CInProcMemBuffer() = default

Default destructor.

inline std::string GetConnectionString() const

Return the connection string.

Returns:

The connection string to connect to this buffer.

inline void TriggerDataSend() override

Trigger listener that a write operation was completed.

inline bool WaitForData(uint32_t uiTimeoutMs) const override

Wait for a write operation to be completed.

Parameters:

uiTimeoutMs – [in] The amount of time (in ms) to wait for a trigger.

Returns:

Returns ‘true’ when data was stored, ‘false’ when a timeout occurred.

inline void TriggerDataReceive() override

Trigger listener that a read operation was completed.

inline bool WaitForFreeSpace(uint32_t uiTimeoutMs) const override

Wait for a read operation to be completed.

Parameters:

uiTimeoutMs – [in] The amount of time (in ms) to wait for a trigger.

Returns:

Returns ‘true’ when data was stored, ‘false’ when a timeout occurred.