<!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>ucommon: ucommon::CharacterProtocol 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="main.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>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00030.html">CharacterProtocol</a>
</div>
</div>
<div class="contents">
<h1>ucommon::CharacterProtocol Class Reference</h1><!-- doxytag: class="ucommon::CharacterProtocol" -->
<p>Common character processing protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00195_source.html">protocols.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::CharacterProtocol:</div>
<div class="dynsection">
<div class="center"><img src="a00352.png" border="0" usemap="#ucommon_1_1_character_protocol_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_character_protocol_inherit__map" id="ucommon_1_1_character_protocol_inherit__map">
<area shape="rect" id="node3" href="a00028.html" title="Common buffer protocol class." alt="" coords="337,56,588,83"/><area shape="rect" id="node13" href="a00029.html" title="Buffered pager for storing paged strings for character protocol." alt="" coords="367,107,559,133"/><area shape="rect" id="node15" href="a00032.html" title="Access standard files through character protocol." alt="" coords="367,157,559,184"/><area shape="rect" id="node17" href="a00147.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="337,208,588,235"/><area shape="rect" id="node5" href="a00050.html" title="A generic file streaming class built from the buffer protocol." alt="" coords="677,5,829,32"/><area shape="rect" id="node7" href="a00135.html" title="Process pipe with I/O buffering." alt="" coords="637,56,869,83"/><area shape="rect" id="node9" href="a00151.html" title="A generic tcp socket class that offers i/o buffering." alt="" coords="652,107,855,133"/><area shape="rect" id="node11" href="a00143.html" title="Secure socket buffer." alt="" coords="917,107,1120,133"/><area shape="rect" id="node19" href="a00051.html" title="Streamable tcp connection between client and server." alt="" coords="648,157,859,184"/><area shape="rect" id="node21" href="a00109.html" title="Streamable tcp connection between client and server." alt="" coords="648,208,859,235"/><area shape="rect" id="node23" href="a00153.html" title="Streamable tcp connection between client and server." alt="" coords="652,259,855,285"/><area shape="rect" id="node25" href="a00144.html" title="Secure socket using std::iostream." alt="" coords="928,259,1109,285"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#a25d4f6715bccf4ec3715e090848d175c">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next character. <a href="#a25d4f6715bccf4ec3715e090848d175c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#acd0e06332a8d9ad12459ed78beb8a26c">put</a> (int code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put the next character. <a href="#acd0e06332a8d9ad12459ed78beb8a26c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#af4c7630fd8ed62d09bb5df069c264a06">_getch</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next character. <a href="#af4c7630fd8ed62d09bb5df069c264a06"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#abc7a3a5f8cd7082fbcad88cbb8f64cc0">_putch</a> (int code)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put the next character. <a href="#abc7a3a5f8cd7082fbcad88cbb8f64cc0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common character processing protocol. </p>
<p>This is used to access a character from some type of streaming buffer or memory object. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00124">124</a> of file <a class="el" href="a00195_source.html">protocols.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af4c7630fd8ed62d09bb5df069c264a06"></a><!-- doxytag: member="ucommon::CharacterProtocol::_getch" ref="af4c7630fd8ed62d09bb5df069c264a06" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int ucommon::CharacterProtocol::_getch </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next character. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next character or EOF. </dd></dl>
<p>Implemented in <a class="el" href="a00028.html#a1b4625218213ad7f1afbcfe2d8524397">ucommon::BufferProtocol</a>, <a class="el" href="a00153.html#a7856b5f2aef36e4091906a2ca8fcf6bf">ucommon::tcpstream</a>, <a class="el" href="a00109.html#aa9f17f4fe231a049d3a626e3cc0abbbf">ucommon::pipestream</a>, and <a class="el" href="a00051.html#ad2cde8f063cc3c3a2cb0c2118780fec0">ucommon::filestream</a>.</p>
</div>
</div>
<a class="anchor" id="abc7a3a5f8cd7082fbcad88cbb8f64cc0"></a><!-- doxytag: member="ucommon::CharacterProtocol::_putch" ref="abc7a3a5f8cd7082fbcad88cbb8f64cc0" args="(int code)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int ucommon::CharacterProtocol::_putch </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>code</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put the next character. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>to put. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>code or EOF if cannot put. </dd></dl>
<p>Implemented in <a class="el" href="a00028.html#a0f3916df35a30ac944977e1751bcf8b5">ucommon::BufferProtocol</a>, <a class="el" href="a00153.html#a982003abba4158fd4660b6153cf3ae49">ucommon::tcpstream</a>, <a class="el" href="a00109.html#a7fb12d4ff4fcb8544e72ef3a2547fdd7">ucommon::pipestream</a>, and <a class="el" href="a00051.html#a65d912082de27da7c1faacce953a33f2">ucommon::filestream</a>.</p>
</div>
</div>
<a class="anchor" id="a25d4f6715bccf4ec3715e090848d175c"></a><!-- doxytag: member="ucommon::CharacterProtocol::get" ref="a25d4f6715bccf4ec3715e090848d175c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::CharacterProtocol::get </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>Get the next character. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next character or EOF. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00145">145</a> of file <a class="el" href="a00195_source.html">protocols.h</a>.</p>
</div>
</div>
<a class="anchor" id="acd0e06332a8d9ad12459ed78beb8a26c"></a><!-- doxytag: member="ucommon::CharacterProtocol::put" ref="acd0e06332a8d9ad12459ed78beb8a26c" args="(int code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::CharacterProtocol::put </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>code</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put the next character. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>to put. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>code or EOF if cannot put. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00153">153</a> of file <a class="el" href="a00195_source.html">protocols.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00195_source.html">protocols.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:30 2011 for ucommon 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
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
56
