lwres_buffer.html revision 7911e6f9de303bca5a3d8b34f4330c8f7cecffae
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User<!--
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - file, You can obtain one at http://mozilla.org/MPL/2.0/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein-->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<html lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<title>lwres_buffer</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User</head>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="id-1"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <div class="refnamediv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Name</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_init,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_invalidate,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User lwres_buffer_add,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_subtract,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_clear,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_first,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User lwres_buffer_forward,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_back,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_getuint8,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_putuint8,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User lwres_buffer_getuint16,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_putuint16,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_getuint32,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User lwres_buffer_putuint32,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User lwres_buffer_putmem,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lwres_buffer_getmem
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein &#8212; lightweight resolver buffer management
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <div class="refsynopsisdiv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Synopsis</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <div class="funcsynopsis">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<pre class="funcsynopsisinfo">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#include &lt;lwres/lwbuffer.h&gt;
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User</pre>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<b class="fsfunc">lwres_buffer_init</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>void *<var class="pdparam">base</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td><code class="funcdef">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox Uservoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_invalidate</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr></table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<b class="fsfunc">lwres_buffer_add</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_subtract</b>(</code></td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>�</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_clear</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr></table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_first</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr></table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<b class="fsfunc">lwres_buffer_forward</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson</tr>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson</table>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<div class="funcprototype-spacer">�</div>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<tr>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<td><code class="funcdef">
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafssonvoid
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<b class="fsfunc">lwres_buffer_back</b>(</code></td>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>�</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>unsigned int <var class="pdparam">n</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_uint8_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_getuint8</b>(</code></td>
a24330c4805a224191ab687d0291963062fe3355Tinderbox User<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr></table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_putuint8</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_uint8_t <var class="pdparam">val</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_uint16_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_getuint16</b>(</code></td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User</tr></table>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<div class="funcprototype-spacer">�</div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_putuint16</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_uint16_t <var class="pdparam">val</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_uint32_t
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_getuint32</b>(</code></td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr></table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="funcprototype-spacer">�</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td><code class="funcdef">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_putuint32</b>(</code></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td>lwres_uint32_t <var class="pdparam">val</var><code>)</code>;</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<div class="funcprototype-spacer">�</div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<tr>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<td><code class="funcdef">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox Uservoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_buffer_putmem</b>(</code></td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
<td>�</td>
<td>const unsigned char *<var class="pdparam">base</var>, </td>
</tr>
<tr>
<td>�</td>
<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">�</div>
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_buffer_getmem</b>(</code></td>
<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
</tr>
<tr>
<td>�</td>
<td>unsigned char *<var class="pdparam">base</var>, </td>
</tr>
<tr>
<td>�</td>
<td>unsigned int <var class="pdparam">length</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">�</div>
</div>
</div>
<div class="refsection">
<a name="id-1.7"></a><h2>DESCRIPTION</h2>
<p>
These functions provide bounds checked access to a region of memory
where data is being read or written.
They are based on, and similar to, the
<code class="literal">isc_buffer_</code>
functions in the ISC library.
</p>
<p>
A buffer is a region of memory, together with a set of related
subregions.
The <span class="emphasis"><em>used region</em></span> and the
<span class="emphasis"><em>available</em></span> region are disjoint, and
their union is the buffer's region.
The used region extends from the beginning of the buffer region to the
last used byte.
The available region extends from one byte greater than the last used
byte to the end of the buffer's region.
The size of the used region can be changed using various
buffer commands.
Initially, the used region is empty.
</p>
<p>
The used region is further subdivided into two disjoint regions: the
<span class="emphasis"><em>consumed region</em></span> and the <span class="emphasis"><em>remaining region</em></span>.
The union of these two regions is the used region.
The consumed region extends from the beginning of the used region to
the byte before the <span class="emphasis"><em>current</em></span> offset (if any).
The <span class="emphasis"><em>remaining</em></span> region the current pointer to the end
of the used
region.
The size of the consumed region can be changed using various
buffer commands.
Initially, the consumed region is empty.
</p>
<p>
The <span class="emphasis"><em>active region</em></span> is an (optional) subregion of the
remaining
region.
It extends from the current offset to an offset in the
remaining region.
Initially, the active region is empty.
If the current offset advances beyond the chosen offset,
the active region will also be empty.
</p>
<pre class="programlisting">
/------------entire length---------------\\
/----- used region -----\\/-- available --\\
+----------------------------------------+
| consumed | remaining | |
+----------------------------------------+
a b c d e
</pre>
<p>
</p>
<pre class="programlisting">
a == base of buffer.
b == current pointer. Can be anywhere between a and d.
c == active pointer. Meaningful between b and d.
d == used pointer.
e == length of buffer.
</pre>
<p>
</p>
<pre class="programlisting">
a-e == entire length of buffer.
a-d == used region.
a-b == consumed region.
b-d == remaining region.
b-c == optional active region.
</pre>
<p>
</p>
<p><code class="function">lwres_buffer_init()</code>
initializes the
<span class="type">lwres_buffer_t</span>
<em class="parameter"><code>*b</code></em>
and assocates it with the memory region of size
<em class="parameter"><code>length</code></em>
bytes starting at location
<em class="parameter"><code>base.</code></em>
</p>
<p><code class="function">lwres_buffer_invalidate()</code>
marks the buffer <em class="parameter"><code>*b</code></em>
as invalid. Invalidating a buffer after use is not required,
but makes it possible to catch its possible accidental use.
</p>
<p>
The functions
<code class="function">lwres_buffer_add()</code>
and
<code class="function">lwres_buffer_subtract()</code>
respectively increase and decrease the used space in
buffer
<em class="parameter"><code>*b</code></em>
by
<em class="parameter"><code>n</code></em>
bytes.
<code class="function">lwres_buffer_add()</code>
checks for buffer overflow and
<code class="function">lwres_buffer_subtract()</code>
checks for underflow.
These functions do not allocate or deallocate memory.
They just change the value of
<code class="varname">used</code>.
</p>
<p>
A buffer is re-initialised by
<code class="function">lwres_buffer_clear()</code>.
The function sets
<code class="varname">used</code>,
<code class="varname">current</code>
and
<code class="varname">active</code>
to zero.
</p>
<p><code class="function">lwres_buffer_first</code>
makes the consumed region of buffer
<em class="parameter"><code>*p</code></em>
empty by setting
<code class="varname">current</code>
to zero (the start of the buffer).
</p>
<p><code class="function">lwres_buffer_forward()</code>
increases the consumed region of buffer
<em class="parameter"><code>*b</code></em>
by
<em class="parameter"><code>n</code></em>
bytes, checking for overflow.
Similarly,
<code class="function">lwres_buffer_back()</code>
decreases buffer
<em class="parameter"><code>b</code></em>'s
consumed region by
<em class="parameter"><code>n</code></em>
bytes and checks for underflow.
</p>
<p><code class="function">lwres_buffer_getuint8()</code>
reads an unsigned 8-bit integer from
<em class="parameter"><code>*b</code></em>
and returns it.
<code class="function">lwres_buffer_putuint8()</code>
writes the unsigned 8-bit integer
<em class="parameter"><code>val</code></em>
to buffer
<em class="parameter"><code>*b</code></em>.
</p>
<p><code class="function">lwres_buffer_getuint16()</code>
and
<code class="function">lwres_buffer_getuint32()</code>
are identical to
<code class="function">lwres_buffer_putuint8()</code>
except that they respectively read an unsigned 16-bit or 32-bit integer
in network byte order from
<em class="parameter"><code>b</code></em>.
Similarly,
<code class="function">lwres_buffer_putuint16()</code>
and
<code class="function">lwres_buffer_putuint32()</code>
writes the unsigned 16-bit or 32-bit integer
<em class="parameter"><code>val</code></em>
to buffer
<em class="parameter"><code>b</code></em>,
in network byte order.
</p>
<p>
Arbitrary amounts of data are read or written from a lightweight
resolver buffer with
<code class="function">lwres_buffer_getmem()</code>
and
<code class="function">lwres_buffer_putmem()</code>
respectively.
<code class="function">lwres_buffer_putmem()</code>
copies
<em class="parameter"><code>length</code></em>
bytes of memory at
<em class="parameter"><code>base</code></em>
to
<em class="parameter"><code>b</code></em>.
Conversely,
<code class="function">lwres_buffer_getmem()</code>
copies
<em class="parameter"><code>length</code></em>
bytes of memory from
<em class="parameter"><code>b</code></em>
to
<em class="parameter"><code>base</code></em>.
</p>
</div>
</div></body>
</html>