<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: Base64 Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1Base64.html">Base64</a>
</div>
</div>
<div class="contents">
<h1>Base64 Class Reference</h1><!-- doxytag: class="TelEngine::Base64" --><!-- doxytag: inherits="TelEngine::DataBlock" --><a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> encoder/decoder class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yateclass_8h-source.html">yateclass.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Base64:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1Base64.png" usemap="#Base64_map" border="0" alt=""></center>
<map name="Base64_map">
<area href="classTelEngine_1_1DataBlock.html" alt="DataBlock" shape="rect" coords="0,56,72,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,72,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1Base64-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#9dc5c821c74246b29a7059933b930e6d">Base64</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#30155b9ed8298af321be03bd232a20b7">Base64</a> (void *src, unsigned int len, bool copyData=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#ba89868c1ef0062c289a38a1eb6743ae">encode</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, unsigned int lineLen=0, bool lineAtEnd=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#903e982542e559c8820a21b3d2a0b6b2">decode</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest, bool liberal=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#c8168a74543a7a4c9a834c8ac0ddc6d1">operator<<</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#97db27728f69d83aa27ef1569c40a7e1">operator<<</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1Base64.html#79013f12cbbd7990cdadc06f93d89ea2">operator<<</a> (const char *value)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> encoder/decoder class.
<p>
<a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> encoder/decoder class <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9dc5c821c74246b29a7059933b930e6d"></a><!-- doxytag: member="TelEngine::Base64::Base64" ref="9dc5c821c74246b29a7059933b930e6d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
</div>
</div><p>
<a class="anchor" name="30155b9ed8298af321be03bd232a20b7"></a><!-- doxytag: member="TelEngine::Base64::Base64" ref="30155b9ed8298af321be03bd232a20b7" args="(void *src, unsigned int len, bool copyData=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>copyData</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Set the buffer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Initial data buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Initial data buffer length </td></tr>
<tr><td valign="top"></td><td valign="top"><em>copyData</em> </td><td>True to make a copy of the received data </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="903e982542e559c8820a21b3d2a0b6b2"></a><!-- doxytag: member="TelEngine::Base64::decode" ref="903e982542e559c8820a21b3d2a0b6b2" args="(DataBlock &dest, bool liberal=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>liberal</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decode this buffer to a destination one <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination data buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>liberal</em> </td><td>True to use 'liberal' rules when decoding. Some non alphabet characters (such as CR, LF, TAB, SPACE or the <a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> padding char '=') will be accepted and ignored. The resulting number of <a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> chars to decode must be a valid one </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on succes, false if an invalid (non <a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a>) character was found or the number of <a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> characters is invalid (must be a multiple of 4 plus 0, 2 or 3 characters) or the padding is incorrect </dd></dl>
</div>
</div><p>
<a class="anchor" name="ba89868c1ef0062c289a38a1eb6743ae"></a><!-- doxytag: member="TelEngine::Base64::encode" ref="ba89868c1ef0062c289a38a1eb6743ae" args="(String &dest, unsigned int lineLen=0, bool lineAtEnd=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>lineLen</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>lineAtEnd</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encode this buffer to a destination string <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lineLen</em> </td><td>The length of a line. If non 0, a line break (CR/LF) will be inserted in the encoded data after each lineLine characters. No line break will be added after the last line. Use the lineAtEnd parameter to do that </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lineAtEnd</em> </td><td>True to add a line break at the end of encoded data </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="79013f12cbbd7990cdadc06f93d89ea2"></a><!-- doxytag: member="TelEngine::Base64::operator<<" ref="79013f12cbbd7990cdadc06f93d89ea2" args="(const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a>& operator<< </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> append operator for C strings
<p>References <a class="el" href="yateclass_8h-source.html#l02977">Base64::operator<<()</a>.</p>
<p>Referenced by <a class="el" href="yateclass_8h-source.html#l02977">Base64::operator<<()</a>.</p>
</div>
</div><p>
<a class="anchor" name="97db27728f69d83aa27ef1569c40a7e1"></a><!-- doxytag: member="TelEngine::Base64::operator<<" ref="97db27728f69d83aa27ef1569c40a7e1" args="(const DataBlock &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a>& operator<< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> append operator for DataBlocks
</div>
</div><p>
<a class="anchor" name="c8168a74543a7a4c9a834c8ac0ddc6d1"></a><!-- doxytag: member="TelEngine::Base64::operator<<" ref="c8168a74543a7a4c9a834c8ac0ddc6d1" args="(const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Base64.html">Base64</a>& operator<< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Base64.html" title="Base64 encoder/decoder class.">Base64</a> append operator for Strings
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yateclass_8h-source.html">yateclass.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:11 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
30
