class CCirBufBase : public CBase |
Base class for circular buffers.
The class is part of the implementation of circular buffers and is never instantiated.
The class provides member functions that form part of the interface.
Public Member Functions | |
---|---|
~CCirBufBase() | |
TInt | Count() |
TInt | Length() |
IMPORT_C void | Reset() |
IMPORT_C void | SetLengthL(TInt) |
Protected Member Functions | |
---|---|
CCirBufBase(TInt) | |
IMPORT_C TInt | DoAdd(const TUint8 *) |
IMPORT_C TInt | DoAdd(const TUint8 *, TInt) |
IMPORT_C TInt | DoRemove(TUint8 *) |
IMPORT_C TInt | DoRemove(TUint8 *, TInt) |
Protected Attributes | |
---|---|
TInt | iCount |
TUint8 * | iHead |
TInt | iLength |
TUint8 * | iPtr |
TUint8 * | iPtrE |
TInt | iSize |
TUint8 * | iTail |
IMPORT_C | CCirBufBase | ( | TInt | aSize | ) | [protected] |
Constructor taking the size of an object within the buffer.
TInt aSize | The size of an object in the buffer. |
IMPORT_C TInt | DoAdd | ( | const TUint8 * | aPtr | ) | [protected] |
Implementation function for CCirBuf::Add(const T*)
Adds a single object to the circular buffer, but only if there is space available.
const TUint8 * aPtr | A pointer to the object to be added. |
IMPORT_C TInt | DoAdd | ( | const TUint8 * | aPtr, |
TInt | aCount | |||
) | [protected] |
Implementation function for CCirBuf::Add(const T*,TInt)
Adds multiple objects to the circular buffer, but only if there is space available.
IMPORT_C TInt | DoRemove | ( | TUint8 * | aPtr | ) | [protected] |
Implementation function for CCirBuf::Remove(T*)
Removes a single object from the circular buffer, but only if there are objects in the buffer.
A binary copy of the object is made to aPtr.
TUint8 * aPtr | A pointer to a location supplied by the caller. |
IMPORT_C TInt | DoRemove | ( | TUint8 * | aPtr, |
TInt | aCount | |||
) | [protected] |
Implementation function for CCirBuf::Remove(T*,TInt)
Attempts to remove aCount objects from the circular buffer, but only if there are objects in the buffer.
A binary copy of the objects is made to aPtr.
TInt | Length | ( | ) | const [inline] |
Gets the maximum capacity of this circular buffer.
The capacity is the maximum number of elements that the buffer can hold.
Use SetLengthL() to change the capacity of the circular buffer.
IMPORT_C void | SetLengthL | ( | TInt | aLength | ) |
Sets the maximum capacity of this circular buffer, and resets all of the buffer pointers.
The capacity is the maximum number of elements that the buffer can hold.
The buffer itself is allocated as a result of a call to this function. If the function has previously been called, then any existing buffer is freed and any information in it is lost.
Notes:
1. This function must be called before attempting to add any objects to the buffer.
2. The function can leave if there is insufficient memory available to allocate the buffer.
TInt aLength | The maximum capacity of the circular buffer. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.