1 <?xml version="1.0" encoding="utf-8"?>

     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

     3 <!-- This component and the accompanying materials are made available under the terms of the License 

     4 "Eclipse Public License v1.0" which accompanies this distribution, 

     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

     6 <!-- Initial Contributors:

     7     Nokia Corporation - initial contribution.

     8 Contributors: 

     9 -->

    10 <!DOCTYPE concept

    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

    12 <concept id="GUID-21C04887-9F9C-5066-AA1D-B30C433CC0AE" xml:lang="en"><title>Circular

    13 Buffers Overview</title><shortdesc>This document is an overview of circular buffers.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <section id="GUID-3A4A5CC7-45A8-4EEB-9CDE-4C9E1FC9FEB4"><title>Purpose</title> <p>Provides a fixed length first-in first-out

    15 queue of fixed-size objects. </p> </section>

    16 <section id="GUID-4C160263-5EA7-4AB8-BDB1-A5649654A9C3"><title>Description</title> <p>Note the following properties of circular

    17 buffers:</p> <ul>

    18 <li id="GUID-03692D38-C81C-51AA-B250-C5A47C0F415D"><p>only simple add, remove,

    19 and reset operations are available</p> </li>

    20 <li id="GUID-491610AC-DFBF-5B61-B7F2-706DAF8E2BB3"><p>elements are added to

    21 the head of the queue and removed from the tail of the queue</p> </li>

    22 <li id="GUID-357A29E1-5447-5638-97D5-5B3C9E61E6E8"><p>all elements in a circular

    23 buffer must be objects of the same type</p> </li>

    24 </ul> <p>Circular buffers are provided by <xref href="GUID-1D73835F-4361-3216-8EFC-669364E3F5E7.dita"><apiname>CCirBuf</apiname></xref> .</p> <p>A

    25 predefined circular buffer of unsigned integers is provided by <xref href="GUID-620EC30F-933F-3073-9E5F-CAC9F2BA4623.dita"><apiname>CCirBuffer</apiname></xref>.</p> </section>

    26 <section id="GUID-732C72C7-02E9-46F8-943F-19ECBD3283F2"><title>See also</title> <p><xref href="GUID-B1BDF68C-F989-56BD-AED4-727595D7355C.dita">Doubly

    27 Linked Lists Overview</xref> </p> </section>

    28 </conbody></concept>