<!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>GNU CommonC++: ost::Buffer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_buffer.html">Buffer</a>
</div>
</div>
<div class="contents">
<h1>ost::Buffer Class Reference</h1><!-- doxytag: class="ost::Buffer" --><!-- doxytag: inherits="ost::Conditional" -->
<p>The buffer class represents an IPC service that is built upon a buffer of fixed capacity that can be used to transfer objects between one or more producer and consumer threads.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::Buffer:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_buffer.png" usemap="#ost::Buffer_map" alt=""/>
<map id="ost::Buffer_map" name="ost::Buffer_map">
<area href="classost_1_1_conditional.html" alt="ost::Conditional" shape="rect" coords="0,0,100,24"/>
<area href="classost_1_1_fixed_buffer.html" alt="ost::FixedBuffer" shape="rect" coords="0,112,100,136"/>
</map>
</div>
</div>
<p><a href="classost_1_1_buffer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#afacde25a803bcf18ed0fc2791fca525d">Buffer</a> (size_t capacity)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a buffer object of known capacity. <a href="#afacde25a803bcf18ed0fc2791fca525d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#aef3a7f472cebcdeca059e2618bf1879c">~Buffer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">In derived functions, may be used to free the actual memory used to hold buffered data. <a href="#aef3a7f472cebcdeca059e2618bf1879c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47">getSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the capacity of the buffer as specified at creation. <a href="#aedd8b294e02c08a60bde023bd2c1ff47"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a462525b42df6660894ccf8141d73071e">getUsed</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current capacity in use for the buffer. <a href="#a462525b42df6660894ccf8141d73071e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a5f67183f492fe6600456d919ed811fac">wait</a> (void *buf, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">timeout</a>=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Let one or more threads wait for an object to become available in the buffer. <a href="#a5f67183f492fe6600456d919ed811fac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a9d106bd44d9bee8d9ef049cfa264e5b7">post</a> (void *buf, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">timeout</a>=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Post an object into the buffer and enable a waiting thread to receive it. <a href="#a9d106bd44d9bee8d9ef049cfa264e5b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#ae613b6a13146b782ce5749b810cceba8">peek</a> (void *buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Peek at the current content (first object) in the buffer. <a href="#ae613b6a13146b782ce5749b810cceba8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a255237cf9eebf6010546e884933ff8ba">isValid</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">New virtual to test if buffer is a valid object. <a href="#a255237cf9eebf6010546e884933ff8ba"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">timeout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">value to return when a timed operation returned with a timeout. <a href="#ae416c78e4d5dc50bfa3c4e0b98fd7a98"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a5879caf00bd75cd972d84b822cb77ef0">onPeek</a> (void *buf)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke derived class buffer peeking method. <a href="#a5879caf00bd75cd972d84b822cb77ef0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a9662e8def92667057121de0847dcabf0">onWait</a> (void *buf)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke derived class object request from buffer. <a href="#a9662e8def92667057121de0847dcabf0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a7ee3158e74f0e50e91f14bf370feb1fa">onPost</a> (void *buf)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke derived class posting of object to buffer. <a href="#a7ee3158e74f0e50e91f14bf370feb1fa"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#abe2397b9087bd1651ee67ed5702c01dd">get</a> (<a class="el" href="classost_1_1_buffer.html">Buffer</a> &b, void *o, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a1dc4ad52b6f17817e4afa981d1db6fae">put</a> (<a class="el" href="classost_1_1_buffer.html">Buffer</a> &b, void *o, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_buffer.html#a2066fdf67ab3b6727be90a51fc5c4d64">peek</a> (<a class="el" href="classost_1_1_buffer.html">Buffer</a> &b, void *o)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The buffer class represents an IPC service that is built upon a buffer of fixed capacity that can be used to transfer objects between one or more producer and consumer threads. </p>
<p>Producer threads post objects into the buffer, and consumer threads wait for and receive objects from the buffer. Semaphores are used to to block the buffer from overflowing and indicate when there is data available, and mutexes are used to protect multiple consumers and producer threads from stepping over each other.</p>
<p>The buffer class is an abstract class in that the actual data being buffered is not directly specified within the buffer class itself. The buffer class should be used as a base class for a class that actually impliments buffering and which may be aware of the data types actually are being buffered. A template class could be created based on buffer for this purpose. Another possibility is to create a class derived from both <a class="el" href="classost_1_1_thread.html" title="Every thread of execution in an application is created by instantiating an object...">Thread</a> and <a class="el" href="classost_1_1_buffer.html" title="The buffer class represents an IPC service that is built upon a buffer of fixed capacity...">Buffer</a> which can be used to implement message passing threads.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Producer/Consumer buffer for use between threads. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afacde25a803bcf18ed0fc2791fca525d"></a><!-- doxytag: member="ost::Buffer::Buffer" ref="afacde25a803bcf18ed0fc2791fca525d" args="(size_t capacity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Buffer::Buffer </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>capacity</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a buffer object of known capacity. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>is the integer capacity of the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aef3a7f472cebcdeca059e2618bf1879c"></a><!-- doxytag: member="ost::Buffer::~Buffer" ref="aef3a7f472cebcdeca059e2618bf1879c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::Buffer::~Buffer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>In derived functions, may be used to free the actual memory used to hold buffered data. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aedd8b294e02c08a60bde023bd2c1ff47"></a><!-- doxytag: member="ost::Buffer::getSize" ref="aedd8b294e02c08a60bde023bd2c1ff47" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::Buffer::getSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the capacity of the buffer as specified at creation. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a462525b42df6660894ccf8141d73071e"></a><!-- doxytag: member="ost::Buffer::getUsed" ref="a462525b42df6660894ccf8141d73071e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::Buffer::getUsed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current capacity in use for the buffer. </p>
<p>Free space is technically <a class="el" href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47" title="Return the capacity of the buffer as specified at creation.">getSize()</a> - <a class="el" href="classost_1_1_buffer.html#a462525b42df6660894ccf8141d73071e" title="Return the current capacity in use for the buffer.">getUsed()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer used capacity of the buffer. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classost_1_1_buffer.html#aedd8b294e02c08a60bde023bd2c1ff47" title="Return the capacity of the buffer as specified at creation.">getSize</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a255237cf9eebf6010546e884933ff8ba"></a><!-- doxytag: member="ost::Buffer::isValid" ref="a255237cf9eebf6010546e884933ff8ba" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::Buffer::isValid </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>New virtual to test if buffer is a valid object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if object is valid. </dd></dl>
<p>Reimplemented in <a class="el" href="classost_1_1_fixed_buffer.html#a0a374a1a50ae78ce64db9e4ab25991d2">ost::FixedBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="a5879caf00bd75cd972d84b822cb77ef0"></a><!-- doxytag: member="ost::Buffer::onPeek" ref="a5879caf00bd75cd972d84b822cb77ef0" args="(void *buf)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ost::Buffer::onPeek </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke derived class buffer peeking method. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object found. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to copy contents of head of buffer to. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classost_1_1_fixed_buffer.html#ae0a0b8dcb25e97313de5b998e1f22bfd">ost::FixedBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="a7ee3158e74f0e50e91f14bf370feb1fa"></a><!-- doxytag: member="ost::Buffer::onPost" ref="a7ee3158e74f0e50e91f14bf370feb1fa" args="(void *buf)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ost::Buffer::onPost </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke derived class posting of object to buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object posted. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to object being posted to the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classost_1_1_fixed_buffer.html#a5d39b3282dd4a18d79456f7f16962b35">ost::FixedBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="a9662e8def92667057121de0847dcabf0"></a><!-- doxytag: member="ost::Buffer::onWait" ref="a9662e8def92667057121de0847dcabf0" args="(void *buf)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t ost::Buffer::onWait </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke derived class object request from buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object returned. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to hold object returned from the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classost_1_1_fixed_buffer.html#a8364661c1b2d2114d87be12479b04a47">ost::FixedBuffer</a>.</p>
</div>
</div>
<a class="anchor" id="ae613b6a13146b782ce5749b810cceba8"></a><!-- doxytag: member="ost::Buffer::peek" ref="ae613b6a13146b782ce5749b810cceba8" args="(void *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::Buffer::peek </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Peek at the current content (first object) in the buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object in the buffer. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to store object found in the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="buffer_8h_source.html#l00358">peek()</a>.</p>
</div>
</div>
<a class="anchor" id="a9d106bd44d9bee8d9ef049cfa264e5b7"></a><!-- doxytag: member="ost::Buffer::post" ref="a9d106bd44d9bee8d9ef049cfa264e5b7" args="(void *buf, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::Buffer::post </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Post an object into the buffer and enable a waiting thread to receive it. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object posted in bytes. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to object to store in the buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>time to wait. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="buffer_8h_source.html#l00354">put()</a>.</p>
</div>
</div>
<a class="anchor" id="a5f67183f492fe6600456d919ed811fac"></a><!-- doxytag: member="ost::Buffer::wait" ref="a5f67183f492fe6600456d919ed811fac" args="(void *buf, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::Buffer::wait </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Let one or more threads wait for an object to become available in the buffer. </p>
<p>The waiting thread(s) will wait forever if no object is ever placed into the buffer.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object passed by buffer in bytes. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to store object retrieved from the buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>time to wait. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abe2397b9087bd1651ee67ed5702c01dd"></a><!-- doxytag: member="ost::Buffer::get" ref="abe2397b9087bd1651ee67ed5702c01dd" args="(Buffer &b, void *o, timeout_t t=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_buffer.html">Buffer</a> & </td>
<td class="paramname"> <em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>t</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2066fdf67ab3b6727be90a51fc5c4d64"></a><!-- doxytag: member="ost::Buffer::peek" ref="a2066fdf67ab3b6727be90a51fc5c4d64" args="(Buffer &b, void *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t peek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_buffer.html">Buffer</a> & </td>
<td class="paramname"> <em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>o</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_sample_socket_port_8cpp-example.html#a2">SampleSocketPort.cpp</a>.</dd>
</dl>
<p>References <a class="el" href="classost_1_1_buffer.html#ae613b6a13146b782ce5749b810cceba8">peek()</a>.</p>
</div>
</div>
<a class="anchor" id="a1dc4ad52b6f17817e4afa981d1db6fae"></a><!-- doxytag: member="ost::Buffer::put" ref="a1dc4ad52b6f17817e4afa981d1db6fae" args="(Buffer &b, void *o, timeout_t t=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t put </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_buffer.html">Buffer</a> & </td>
<td class="paramname"> <em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>t</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classost_1_1_buffer.html#a9d106bd44d9bee8d9ef049cfa264e5b7">post()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae416c78e4d5dc50bfa3c4e0b98fd7a98"></a><!-- doxytag: member="ost::Buffer::timeout" ref="ae416c78e4d5dc50bfa3c4e0b98fd7a98" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const size_t <a class="el" href="classost_1_1_buffer.html#ae416c78e4d5dc50bfa3c4e0b98fd7a98">ost::Buffer::timeout</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>value to return when a timed operation returned with a timeout. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="buffer_8h_source.html">buffer.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
87
