blob: 5ed6b68fe845311bedbff05378cd2d1fb6b56ed2 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: encoder</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1codec_1_1encoder.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classproton_1_1codec_1_1encoder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">encoder</div> </div>
</div><!--header-->
<div class="contents">
<p><b>Unsettled API</b> - A stream-like encoder from C++ values to AMQP bytes.
<a href="classproton_1_1codec_1_1encoder.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="encoder_8hpp_source.html">encoder.hpp</a>&gt;</code></p>
<p>Inherits data.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c0a094e7f852de0a4197c0fdab85004"><td class="memItemLeft" align="right" valign="top"><a id="a3c0a094e7f852de0a4197c0fdab85004"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#a3c0a094e7f852de0a4197c0fdab85004">encoder</a> (const data &amp;d)</td></tr>
<tr class="memdesc:a3c0a094e7f852de0a4197c0fdab85004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap Proton-C data object. <br /></td></tr>
<tr class="separator:a3c0a094e7f852de0a4197c0fdab85004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6da1725854567e26466e4824df73d178"><td class="memItemLeft" align="right" valign="top"><a id="a6da1725854567e26466e4824df73d178"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#a6da1725854567e26466e4824df73d178">encoder</a> (internal::value_base &amp;v)</td></tr>
<tr class="memdesc:a6da1725854567e26466e4824df73d178"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoder into v. Clears any current value in v. <br /></td></tr>
<tr class="separator:a6da1725854567e26466e4824df73d178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05b307b3735c19f17f1fadf74921cd8b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#a05b307b3735c19f17f1fadf74921cd8b">encode</a> (char *buffer, size_t &amp;size)</td></tr>
<tr class="memdesc:a05b307b3735c19f17f1fadf74921cd8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode the current values into buffer and update size to reflect the number of bytes encoded. <a href="classproton_1_1codec_1_1encoder.html#a05b307b3735c19f17f1fadf74921cd8b">More...</a><br /></td></tr>
<tr class="separator:a05b307b3735c19f17f1fadf74921cd8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2131a7ce711f2e6a84ebe1d47cc5777"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#ac2131a7ce711f2e6a84ebe1d47cc5777">encode</a> (std::string &amp;)</td></tr>
<tr class="memdesc:ac2131a7ce711f2e6a84ebe1d47cc5777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode the current values into a std::string and resize the string if necessary. <a href="classproton_1_1codec_1_1encoder.html#ac2131a7ce711f2e6a84ebe1d47cc5777">More...</a><br /></td></tr>
<tr class="separator:ac2131a7ce711f2e6a84ebe1d47cc5777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad236fe917e7543c22425a12bddbdc821"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#ad236fe917e7543c22425a12bddbdc821">encode</a> ()</td></tr>
<tr class="memdesc:ad236fe917e7543c22425a12bddbdc821"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode the current values into a std::string. <a href="classproton_1_1codec_1_1encoder.html#ad236fe917e7543c22425a12bddbdc821">More...</a><br /></td></tr>
<tr class="separator:ad236fe917e7543c22425a12bddbdc821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a041e90045de495b728fb95bbed97a531"><td class="memItemLeft" align="right" valign="top"><a id="a041e90045de495b728fb95bbed97a531"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#a041e90045de495b728fb95bbed97a531">operator&lt;&lt;</a> (const internal::value_base &amp;)</td></tr>
<tr class="memdesc:a041e90045de495b728fb95bbed97a531"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a <a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex.">proton::value</a>. <br /></td></tr>
<tr class="separator:a041e90045de495b728fb95bbed97a531"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae899d62164114228541da27e80372bc2"><td class="memItemLeft" align="right" valign="top"><a id="ae899d62164114228541da27e80372bc2"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#ae899d62164114228541da27e80372bc2">operator&lt;&lt;</a> (const <a class="el" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> &amp;)</td></tr>
<tr class="memdesc:ae899d62164114228541da27e80372bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a complex type. <br /></td></tr>
<tr class="separator:ae899d62164114228541da27e80372bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ffe2e23e17b2c241074e52944916e8a"><td class="memItemLeft" align="right" valign="top"><a id="a4ffe2e23e17b2c241074e52944916e8a"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1codec_1_1encoder.html#a4ffe2e23e17b2c241074e52944916e8a">operator&lt;&lt;</a> (const <a class="el" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1finish">finish</a> &amp;)</td></tr>
<tr class="memdesc:a4ffe2e23e17b2c241074e52944916e8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish a complex type. <br /></td></tr>
<tr class="separator:a4ffe2e23e17b2c241074e52944916e8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Insert built-in types</div></td></tr>
<tr class="memitem:afa468f3d76819d6270f8065f4cb805d6"><td class="memItemLeft" align="right" valign="top"><a id="afa468f3d76819d6270f8065f4cb805d6"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (bool)</td></tr>
<tr class="separator:afa468f3d76819d6270f8065f4cb805d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af97ad446d4405daa02b4b6be8e7737ec"><td class="memItemLeft" align="right" valign="top"><a id="af97ad446d4405daa02b4b6be8e7737ec"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (uint8_t)</td></tr>
<tr class="separator:af97ad446d4405daa02b4b6be8e7737ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae45c710375811896a4d7be67ced2f95"><td class="memItemLeft" align="right" valign="top"><a id="aae45c710375811896a4d7be67ced2f95"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (int8_t)</td></tr>
<tr class="separator:aae45c710375811896a4d7be67ced2f95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a289344af804abf24123b27a593cf6d75"><td class="memItemLeft" align="right" valign="top"><a id="a289344af804abf24123b27a593cf6d75"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (uint16_t)</td></tr>
<tr class="separator:a289344af804abf24123b27a593cf6d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a256cc7b4b7dd7892e0c9ddd227aa2d08"><td class="memItemLeft" align="right" valign="top"><a id="a256cc7b4b7dd7892e0c9ddd227aa2d08"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (int16_t)</td></tr>
<tr class="separator:a256cc7b4b7dd7892e0c9ddd227aa2d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787671d718220595f9586b4364d63423"><td class="memItemLeft" align="right" valign="top"><a id="a787671d718220595f9586b4364d63423"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (uint32_t)</td></tr>
<tr class="separator:a787671d718220595f9586b4364d63423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9911728c8cb7ffe20a16f7127a1db017"><td class="memItemLeft" align="right" valign="top"><a id="a9911728c8cb7ffe20a16f7127a1db017"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (int32_t)</td></tr>
<tr class="separator:a9911728c8cb7ffe20a16f7127a1db017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b86eb0a2446ffdb575e025d01b6125e"><td class="memItemLeft" align="right" valign="top"><a id="a5b86eb0a2446ffdb575e025d01b6125e"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (wchar_t)</td></tr>
<tr class="separator:a5b86eb0a2446ffdb575e025d01b6125e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58d4ee3210ac38139b21b37395cded82"><td class="memItemLeft" align="right" valign="top"><a id="a58d4ee3210ac38139b21b37395cded82"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (uint64_t)</td></tr>
<tr class="separator:a58d4ee3210ac38139b21b37395cded82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99a09d3c83841c60328ef3baa99d792a"><td class="memItemLeft" align="right" valign="top"><a id="a99a09d3c83841c60328ef3baa99d792a"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (int64_t)</td></tr>
<tr class="separator:a99a09d3c83841c60328ef3baa99d792a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc8b873db5e5ad60cc147fa7837eb66"><td class="memItemLeft" align="right" valign="top"><a id="a2bc8b873db5e5ad60cc147fa7837eb66"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (<a class="el" href="classproton_1_1timestamp.html">timestamp</a>)</td></tr>
<tr class="separator:a2bc8b873db5e5ad60cc147fa7837eb66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3863df939a84acdd057bbe64c11cae3"><td class="memItemLeft" align="right" valign="top"><a id="aa3863df939a84acdd057bbe64c11cae3"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (float)</td></tr>
<tr class="separator:aa3863df939a84acdd057bbe64c11cae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a637be23190575b2606bf7f2babbeed6b"><td class="memItemLeft" align="right" valign="top"><a id="a637be23190575b2606bf7f2babbeed6b"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (double)</td></tr>
<tr class="separator:a637be23190575b2606bf7f2babbeed6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d0287b4b20df95b953f6dca6b508a55"><td class="memItemLeft" align="right" valign="top"><a id="a6d0287b4b20df95b953f6dca6b508a55"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (<a class="el" href="classproton_1_1decimal32.html">decimal32</a>)</td></tr>
<tr class="separator:a6d0287b4b20df95b953f6dca6b508a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5bb6a3c6c371d3413e701fb7e44771a"><td class="memItemLeft" align="right" valign="top"><a id="ae5bb6a3c6c371d3413e701fb7e44771a"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (<a class="el" href="classproton_1_1decimal64.html">decimal64</a>)</td></tr>
<tr class="separator:ae5bb6a3c6c371d3413e701fb7e44771a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af67234a0da37a0f53dec9583325f81e9"><td class="memItemLeft" align="right" valign="top"><a id="af67234a0da37a0f53dec9583325f81e9"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (<a class="el" href="classproton_1_1decimal128.html">decimal128</a>)</td></tr>
<tr class="separator:af67234a0da37a0f53dec9583325f81e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a026090b41c4124df80ff12eb7376d97c"><td class="memItemLeft" align="right" valign="top"><a id="a026090b41c4124df80ff12eb7376d97c"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const <a class="el" href="classproton_1_1uuid.html">uuid</a> &amp;)</td></tr>
<tr class="separator:a026090b41c4124df80ff12eb7376d97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdab0295f119a4badf63a947d508ef97"><td class="memItemLeft" align="right" valign="top"><a id="afdab0295f119a4badf63a947d508ef97"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const std::string &amp;)</td></tr>
<tr class="separator:afdab0295f119a4badf63a947d508ef97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc4b560a005e9160693c85aae05086a0"><td class="memItemLeft" align="right" valign="top"><a id="abc4b560a005e9160693c85aae05086a0"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const <a class="el" href="classproton_1_1symbol.html">symbol</a> &amp;)</td></tr>
<tr class="separator:abc4b560a005e9160693c85aae05086a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d41565e7410ec7a72097da5b399fd79"><td class="memItemLeft" align="right" valign="top"><a id="a2d41565e7410ec7a72097da5b399fd79"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const <a class="el" href="classproton_1_1binary.html">binary</a> &amp;)</td></tr>
<tr class="separator:a2d41565e7410ec7a72097da5b399fd79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c97aab9f563c515301adb35951b752"><td class="memItemLeft" align="right" valign="top"><a id="a79c97aab9f563c515301adb35951b752"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const <a class="el" href="classproton_1_1scalar__base.html">scalar_base</a> &amp;)</td></tr>
<tr class="separator:a79c97aab9f563c515301adb35951b752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a22fc8bfea6eee79c2af6e1c66f8f59"><td class="memItemLeft" align="right" valign="top"><a id="a1a22fc8bfea6eee79c2af6e1c66f8f59"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (const <a class="el" href="classproton_1_1null.html">null</a> &amp;)</td></tr>
<tr class="separator:a1a22fc8bfea6eee79c2af6e1c66f8f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37c5cab14118fbcf7e37fb35e4e09246"><td class="memItemLeft" align="right" valign="top"><a id="a37c5cab14118fbcf7e37fb35e4e09246"></a>
<a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;&lt;</b> (decltype(nullptr))</td></tr>
<tr class="separator:a37c5cab14118fbcf7e37fb35e4e09246"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><b>Unsettled API</b> - A stream-like encoder from C++ values to AMQP bytes. </p>
<p>For internal use only.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="types_page.html">AMQP and C++ types</a> for the recommended ways to manage AMQP data </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a05b307b3735c19f17f1fadf74921cd8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05b307b3735c19f17f1fadf74921cd8b">&#9670;&nbsp;</a></span>encode() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool encode </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t &amp;&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode the current values into buffer and update size to reflect the number of bytes encoded. </p>
<p>Clears the encoder.</p>
<dl class="section return"><dt>Returns</dt><dd>if buffer == 0 or size is too small, then return false and size to the required size. Otherwise, return true and set size to the number of bytes encoded. </dd></dl>
</div>
</div>
<a id="ac2131a7ce711f2e6a84ebe1d47cc5777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2131a7ce711f2e6a84ebe1d47cc5777">&#9670;&nbsp;</a></span>encode() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void encode </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode the current values into a std::string and resize the string if necessary. </p>
<p>Clears the encoder. </p>
</div>
</div>
<a id="ad236fe917e7543c22425a12bddbdc821"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad236fe917e7543c22425a12bddbdc821">&#9670;&nbsp;</a></span>encode() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string encode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode the current values into a std::string. </p>
<p>Clears the encoder. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/codec/<a class="el" href="encoder_8hpp_source.html">encoder.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="namespaceproton_1_1codec.html">codec</a></li><li class="navelem"><a class="el" href="classproton_1_1codec_1_1encoder.html">encoder</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>