Symbian3/SDK/Source/GUID-21C04887-9F9C-5066-AA1D-B30C433CC0AE.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 0 89d6a7a84779
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-21C04887-9F9C-5066-AA1D-B30C433CC0AE" xml:lang="en"><title>Circular
Buffers Overview</title><shortdesc>This document is an overview of circular buffers.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
<section id="GUID-3A4A5CC7-45A8-4EEB-9CDE-4C9E1FC9FEB4"><title>Purpose</title> <p>Provides a fixed length first-in first-out
queue of fixed-size objects. </p> </section>
<section id="GUID-4C160263-5EA7-4AB8-BDB1-A5649654A9C3"><title>Description</title> <p>Note the following properties of circular
buffers:</p> <ul>
<li id="GUID-03692D38-C81C-51AA-B250-C5A47C0F415D"><p>only simple add, remove,
and reset operations are available</p> </li>
<li id="GUID-491610AC-DFBF-5B61-B7F2-706DAF8E2BB3"><p>elements are added to
the head of the queue and removed from the tail of the queue</p> </li>
<li id="GUID-357A29E1-5447-5638-97D5-5B3C9E61E6E8"><p>all elements in a circular
buffer must be objects of the same type</p> </li>
</ul> <p>Circular buffers are provided by <xref href="GUID-1D73835F-4361-3216-8EFC-669364E3F5E7.dita"><apiname>CCirBuf</apiname></xref> .</p> <p>A
predefined circular buffer of unsigned integers is provided by <xref href="GUID-620EC30F-933F-3073-9E5F-CAC9F2BA4623.dita"><apiname>CCirBuffer</apiname></xref>.</p> </section>
<section id="GUID-732C72C7-02E9-46F8-943F-19ECBD3283F2"><title>See also</title> <p><xref href="GUID-B1BDF68C-F989-56BD-AED4-727595D7355C.dita">Doubly
Linked Lists Overview</xref> </p> </section>
</conbody></concept>