<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: CyclicBuffer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1helpers_1_1_cyclic_buffer.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>CyclicBuffer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::CyclicBuffer" -->
<p><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html" title="CyclicBuffer is used by other appenders to hold instances of LoggingEvent for immediate or deferred d...">CyclicBuffer</a> is used by other appenders to hold instances of <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> for immediate or deferred display.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1helpers_1_1_cyclic_buffer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#acba9071c4d0eb3671e686e73d19bab40">CyclicBuffer</a> (int maxSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a new <a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html" title="CyclicBuffer is used by other appenders to hold instances of LoggingEvent for immediate or deferred d...">CyclicBuffer</a> of at most <code>maxSize</code> events. <a href="#acba9071c4d0eb3671e686e73d19bab40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#a0e064a0e9c783c50a3ddeebcd59fb0ee">~CyclicBuffer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#aed460fe1de28e3e2c98ff110a26aebab">add</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>event</code> as the last event in the buffer. <a href="#aed460fe1de28e3e2c98ff110a26aebab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#a87ffb0bb5b80153c19481c4e0e1d6d5e">get</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <em>i</em>th oldest event currently in the buffer. <a href="#a87ffb0bb5b80153c19481c4e0e1d6d5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#af4f2c480908c2bdb309699d15cca3a80">getMaxSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#adb9eaabb59e592b6770d7760792fdd97">get</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the oldest (first) element in the buffer. <a href="#adb9eaabb59e592b6770d7760792fdd97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#a57b988236ee6a3a5e572d126d3fbccc1">length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of elements in the buffer. <a href="#a57b988236ee6a3a5e572d126d3fbccc1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html#ab8b22b9d0f25d76dda44f79aeabd826f">resize</a> (int newSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize the cyclic buffer to <code>newSize</code>. <a href="#ab8b22b9d0f25d76dda44f79aeabd826f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html" title="CyclicBuffer is used by other appenders to hold instances of LoggingEvent for immediate or deferred d...">CyclicBuffer</a> is used by other appenders to hold instances of <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> for immediate or deferred display. </p>
<p>This buffer gives read access to any element in the buffer not just the first or last element. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acba9071c4d0eb3671e686e73d19bab40"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::CyclicBuffer" ref="acba9071c4d0eb3671e686e73d19bab40" args="(int maxSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html">CyclicBuffer</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a new <a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html" title="CyclicBuffer is used by other appenders to hold instances of LoggingEvent for immediate or deferred d...">CyclicBuffer</a> of at most <code>maxSize</code> events. </p>
<p>The <code>maxSize</code> argument must a positive integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">maxSize</td><td>The maximum number of elements in the buffer. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classlog4cxx_1_1helpers_1_1_illegal_argument_exception.html" title="Thrown to indicate that a method has been passed an illegal or inappropriate argument.">IllegalArgumentException</a></td><td>if <code>maxSize</code> is negative. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0e064a0e9c783c50a3ddeebcd59fb0ee"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::~CyclicBuffer" ref="a0e064a0e9c783c50a3ddeebcd59fb0ee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html">CyclicBuffer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aed460fe1de28e3e2c98ff110a26aebab"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::add" ref="aed460fe1de28e3e2c98ff110a26aebab" args="(const spi::LoggingEventPtr &event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an <code>event</code> as the last event in the buffer. </p>
</div>
</div>
<a class="anchor" id="a87ffb0bb5b80153c19481c4e0e1d6d5e"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::get" ref="a87ffb0bb5b80153c19481c4e0e1d6d5e" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> get </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the <em>i</em>th oldest event currently in the buffer. </p>
<p>If <em>i</em> is outside the range 0 to the number of elements currently in the buffer, then <code>null</code> is returned. </p>
</div>
</div>
<a class="anchor" id="adb9eaabb59e592b6770d7760792fdd97"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::get" ref="adb9eaabb59e592b6770d7760792fdd97" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the oldest (first) element in the buffer. </p>
<p>The oldest element is removed from the buffer. </p>
</div>
</div>
<a class="anchor" id="af4f2c480908c2bdb309699d15cca3a80"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::getMaxSize" ref="af4f2c480908c2bdb309699d15cca3a80" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getMaxSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a57b988236ee6a3a5e572d126d3fbccc1"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::length" ref="a57b988236ee6a3a5e572d126d3fbccc1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int length </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of elements in the buffer. </p>
<p>This number is guaranteed to be in the range 0 to <code>maxSize</code> (inclusive). </p>
</div>
</div>
<a class="anchor" id="ab8b22b9d0f25d76dda44f79aeabd826f"></a><!-- doxytag: member="log4cxx::helpers::CyclicBuffer::resize" ref="ab8b22b9d0f25d76dda44f79aeabd826f" args="(int newSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void resize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>newSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resize the cyclic buffer to <code>newSize</code>. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classlog4cxx_1_1helpers_1_1_illegal_argument_exception.html" title="Thrown to indicate that a method has been passed an illegal or inappropriate argument.">IllegalArgumentException</a></td><td>if <code>newSize</code> is negative. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cyclicbuffer_8h.html">cyclicbuffer.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_cyclic_buffer.html">CyclicBuffer</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
