#include <ball_fixedsizerecordbuffer.h>
Public Member Functions | |
| BSLMF_NESTED_TRAIT_DECLARATION (FixedSizeRecordBuffer, bslma::UsesBslmaAllocator) | |
| FixedSizeRecordBuffer (int maxTotalSize, bslma::Allocator *basicAllocator=0) | |
| virtual | ~FixedSizeRecordBuffer () |
| virtual void | beginSequence () |
| virtual void | endSequence () |
| virtual void | popBack () |
| virtual void | popFront () |
| virtual int | pushBack (const bsl::shared_ptr< Record > &handle) |
| virtual int | pushFront (const bsl::shared_ptr< Record > &handle) |
| virtual void | removeAll () |
| virtual const bsl::shared_ptr < Record > & | back () const |
| virtual const bsl::shared_ptr < Record > & | front () const |
| virtual int | length () const |
Detailed Description
This class provides a concrete, thread-safe implementation of the RecordBuffer protocol. This class is a mechanism. At any time, the sum of sizes of all records contained in a FixedSizeRecordBuffer object plus the amount of memory allocated by the FixedSizeRecordBuffer object itself is guaranteed to be less than or equal to an upper bound specified at creation. The class is thread-safe, except that the methods front and back must be called after locking the buffer by invoking beginSequence. In order to accommodate a pushBack request, the records from the front end of the buffer may be removed. Similarly, in order to accommodate a pushFront request, the records from the back end of the buffer may be removed. If a record can not accommodate in the buffer, it is silently (but otherwise safely) discarded.
See Component ball_fixedsizerecordbuffer
Constructor & Destructor Documentation
| ball::FixedSizeRecordBuffer::FixedSizeRecordBuffer | ( | int | maxTotalSize, | |
| bslma::Allocator * | basicAllocator = 0 | |||
| ) |
Create a limited record buffer such that at any time the sum of sizes of all records contained plus the amount of memory allocated by this object is guaranteed to be less than or equal to the specified maxTotalSize. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. The behavior is undefined unless maxTotalSize > 0.
| virtual ball::FixedSizeRecordBuffer::~FixedSizeRecordBuffer | ( | ) | [virtual] |
Remove all record handles from this record buffer and destroy this record buffer.
Member Function Documentation
| ball::FixedSizeRecordBuffer::BSLMF_NESTED_TRAIT_DECLARATION | ( | FixedSizeRecordBuffer | , | |
| bslma::UsesBslmaAllocator | ||||
| ) |
| virtual void ball::FixedSizeRecordBuffer::beginSequence | ( | ) | [virtual] |
Lock this record buffer so that a sequence of method invocations on this record buffer can occur uninterrupted by other threads. The buffer will remain locked until endSequence is called. It is valid to invoke other methods on this record buffer between the calls to beginSequence and endSequence (the implementation guarantees this by employing a recursive mutex).
Implements ball::RecordBuffer.
| virtual void ball::FixedSizeRecordBuffer::endSequence | ( | ) | [virtual] |
Unlock this record buffer, thus allowing other threads to access it. The behavior is undefined unless the buffer is already locked by beginSequence.
Implements ball::RecordBuffer.
| virtual void ball::FixedSizeRecordBuffer::popBack | ( | ) | [virtual] |
Remove from this record buffer the record handle positioned at the back end of the buffer. The behavior is undefined unless 0 < length().
Implements ball::RecordBuffer.
| virtual void ball::FixedSizeRecordBuffer::popFront | ( | ) | [virtual] |
Remove from this record buffer the record handle positioned at the front end of the buffer. The behavior is undefined unless 0 < length().
Implements ball::RecordBuffer.
| virtual int ball::FixedSizeRecordBuffer::pushBack | ( | const bsl::shared_ptr< Record > & | handle | ) | [virtual] |
Push the specified handle at the back end of this record buffer. Return 0 on success, and a non-zero value otherwise. In order to accommodate a record, the records from the front end of the buffer may be removed. If a record can not be accommodated in the buffer, it is silently discarded.
Implements ball::RecordBuffer.
| virtual int ball::FixedSizeRecordBuffer::pushFront | ( | const bsl::shared_ptr< Record > & | handle | ) | [virtual] |
Push the specified handle at the front end of this record buffer. Return 0 on success, and a non-zero value otherwise. In order to accommodate a record, the records from the end end of the buffer may be removed. If a record can not be accommodated in the buffer, it is silently discarded.
Implements ball::RecordBuffer.
| virtual void ball::FixedSizeRecordBuffer::removeAll | ( | ) | [virtual] |
Remove all record handles stored in this record buffer. Note that length() is now 0.
Implements ball::RecordBuffer.
| virtual const bsl::shared_ptr<Record>& ball::FixedSizeRecordBuffer::back | ( | ) | const [virtual] |
Return a reference of the shared pointer referring to the record positioned at the back end of this record buffer. The behavior is undefined unless this record buffer has been locked by the beginSequence method and unless 0 < length().
Implements ball::RecordBuffer.
| virtual const bsl::shared_ptr<Record>& ball::FixedSizeRecordBuffer::front | ( | ) | const [virtual] |
Return a reference of the shared pointer referring to the record positioned at the front end of this record buffer. The behavior is undefined unless this record buffer has been locked by the beginSequence method and unless 0 < length().
Implements ball::RecordBuffer.
| virtual int ball::FixedSizeRecordBuffer::length | ( | ) | const [virtual] |
Return the number of record handles in this record buffer.
Implements ball::RecordBuffer.
The documentation for this class was generated from the following file:
Generated on Fri Mar 31 2023 13:26:58 for BDE Release 3.115.0.0 Production Release by
1.7.1