You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2017/08/30 03:12:57 UTC
[38/51] [partial] qpid-site git commit: QPID-7903: Publish a snapshot
of the Proton C docs
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/36c59045/content/releases/qpid-proton-master/proton/c/api/group__data.html
----------------------------------------------------------------------
diff --git a/content/releases/qpid-proton-master/proton/c/api/group__data.html b/content/releases/qpid-proton-master/proton/c/api/group__data.html
index 80937e9..6229c2b 100755
--- a/content/releases/qpid-proton-master/proton/c/api/group__data.html
+++ b/content/releases/qpid-proton-master/proton/c/api/group__data.html
@@ -3,7 +3,8 @@
<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.11"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C API: Data</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -14,7 +15,6 @@
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
- $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
@@ -55,7 +55,7 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.11 -->
+<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -352,7 +352,9 @@ Functions</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A data structure for AMQP data. </p>
<h2 class="groupheader">Typedef Documentation</h2>
-<a class="anchor" id="ga5d6cf528776e8b6ad6d67caf095986bf"></a>
+<a id="ga5d6cf528776e8b6ad6d67caf095986bf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga5d6cf528776e8b6ad6d67caf095986bf">◆ </a></span>pn_data_t</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -394,7 +396,9 @@ Functions</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="gac21c6f1c517ac486e2923baa3d0c5db4"></a>
+<a id="gac21c6f1c517ac486e2923baa3d0c5db4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gac21c6f1c517ac486e2923baa3d0c5db4">◆ </a></span>pn_data()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -420,91 +424,67 @@ Functions</h2></td></tr>
</div>
</div>
-<a class="anchor" id="ga0a98b8f17784460034c240ed4b6b47d7"></a>
+<a id="ga2c02eee58084ba9b77a37c086e195802"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga2c02eee58084ba9b77a37c086e195802">◆ </a></span>pn_data_free()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int pn_data_append </td>
+ <td class="memname">void pn_data_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>src</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>data</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Append the contents of another pn_data_t object. </p>
+<p>Free a pn_data_t object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
- <tr><td class="paramname">src</td><td>the sourc pn_data_t to append from </td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data_t object or NULL </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga9a048cfd78ca76604b667d170eac0136"></a>
+<a id="ga68e94dfa5d7ab568425c4a6587bac1db"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga68e94dfa5d7ab568425c4a6587bac1db">◆ </a></span>pn_data_errno()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int pn_data_appendn </td>
+ <td class="memname">int pn_data_errno </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>src</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>limit</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>data</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Append up to <em>n</em> values from the contents of another pn_data_t object. </p>
+<p>Access the current error code for a given pn_data_t. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
- <tr><td class="paramname">src</td><td>the sourc pn_data_t to append from </td></tr>
- <tr><td class="paramname">limit</td><td>the maximum number of values to append </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>the current error code </dd></dl>
</div>
</div>
-<a class="anchor" id="ga7611c1394e80b5166b8b8647659f97e6"></a>
+<a id="gada171f4740e6a1132b4d4b9c0aea645c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gada171f4740e6a1132b4d4b9c0aea645c">◆ </a></span>pn_data_error()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_data_clear </td>
+ <td class="memname"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>* pn_data_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -513,105 +493,81 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Clears a pn_data_t object. </p>
-<p>A cleared pn_data_t object is equivalent to a newly constructed one.</p>
+<p>Access the current error for a givn pn_data_t. </p>
+<p>Every pn_data_t has an error descriptor that is created with the pn_data_t and dies with the pn_data_t. The error descriptor is updated whenever an operation fails. The <a class="el" href="group__data.html#gada171f4740e6a1132b4d4b9c0aea645c" title="Access the current error for a givn pn_data_t. ">pn_data_error()</a> function may be used to access a pn_data_t's error descriptor.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>the pn_data_t object to clear </td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>a pointer to the pn_data_t's error descriptor </dd></dl>
</div>
</div>
-<a class="anchor" id="gaf0e0fbb9c8c757f94b9636a6b54dc332"></a>
+<a id="ga7611c1394e80b5166b8b8647659f97e6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga7611c1394e80b5166b8b8647659f97e6">◆ </a></span>pn_data_clear()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int pn_data_copy </td>
+ <td class="memname">void pn_data_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>src</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>data</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Copy the contents of another pn_data_t object. </p>
-<p>Any values in the data object will be lost.</p>
+<p>Clears a pn_data_t object. </p>
+<p>A cleared pn_data_t object is equivalent to a newly constructed one.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
- <tr><td class="paramname">src</td><td>the sourc pn_data_t to copy from </td></tr>
+ <tr><td class="paramname">data</td><td>the pn_data_t object to clear </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga74430b712be334a05861cfd5e9b312b9"></a>
+<a id="ga148ae972de23a6694cd18a510eee4856"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga148ae972de23a6694cd18a510eee4856">◆ </a></span>pn_data_size()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">ssize_t pn_data_decode </td>
+ <td class="memname">size_t pn_data_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>bytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>data</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Decodes a single value from the contents of the AMQP data stream into the current data object. </p>
-<p>Note that if the pn_data_t object is pointing to a current node, the decoded value will overwrite the current one. If the pn_data_t object has no current node then a node will be appended to the current parent. If there is no current parent then a node will be appended to the pn_data_t itself.</p>
-<p>Upon success, this operation returns the number of bytes consumed from the AMQP data stream. Upon failure, this operation returns an error code.</p>
+<p>Returns the total number of nodes contained in a pn_data_t object. </p>
+<p>This includes all parents, children, siblings, grandchildren, etc. In other words the count of all ancesters and descendents of the current node, along with the current node if there is one.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
- <tr><td class="paramname">bytes</td><td>a pointer to an encoded AMQP data stream </td></tr>
- <tr><td class="paramname">size</td><td>the size of the encoded AMQP data stream </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the number of bytes consumed from the AMQP data stream or an error code </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>the total number of nodes in the pn_data_t object </dd></dl>
</div>
</div>
-<a class="anchor" id="ga502e9571b513b58bce5a5ae442951400"></a>
+<a id="ga26d61fd9b512c322344d410384202005"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga26d61fd9b512c322344d410384202005">◆ </a></span>pn_data_rewind()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_data_dump </td>
+ <td class="memname">void pn_data_rewind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -620,65 +576,47 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Dumps a debug representation of the internal state of the pn_data_t object that includes its navigational state to stdout for debugging purposes. </p>
-<dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object that is behaving in a confusing way </td></tr>
- </table>
- </dd>
-</dl>
+<p>Clears current node pointer and sets the parent to the root node. </p>
+<p>Clearing the current node sets it <em>before</em> the first node, calling <a class="el" href="group__data.html#ga96c9a1c5f179036cd9513c50c0ac57de" title="Advances the current node to its next sibling and returns true. ">pn_data_next()</a> will advance to the first node. </p>
</div>
</div>
-<a class="anchor" id="ga5502724bcde68615bc47e09a3335b527"></a>
+<a id="ga96c9a1c5f179036cd9513c50c0ac57de"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga96c9a1c5f179036cd9513c50c0ac57de">◆ </a></span>pn_data_next()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">ssize_t pn_data_encode </td>
+ <td class="memname">bool pn_data_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>bytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
+ <td class="paramname"><em>data</em></td><td>)</td>
<td></td>
- <td>)</td>
- <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Writes the contents of a data object to the given buffer as an AMQP data stream. </p>
+<p>Advances the current node to its next sibling and returns true. </p>
+<p>If there is no next sibling the current node remains unchanged and false is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>the data object to encode </td></tr>
- <tr><td class="paramname">bytes</td><td>the buffer for encoded data </td></tr>
- <tr><td class="paramname">size</td><td>the size of the buffer</td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the size of the encoded data on success or an error code on failure </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>true iff the current node was changed </dd></dl>
</div>
</div>
-<a class="anchor" id="gae71bfb440cc4f0b15fe958bf55a3f6af"></a>
+<a id="ga9ee214dd19c845f76e29651682732e16"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga9ee214dd19c845f76e29651682732e16">◆ </a></span>pn_data_prev()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">ssize_t pn_data_encoded_size </td>
+ <td class="memname">bool pn_data_prev </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -687,18 +625,21 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Returns the number of bytes needed to encode a data object. </p>
+<p>Moves the current node to its previous sibling and returns true. </p>
+<p>If there is no previous sibling the current node remains unchanged and false is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>the data object</td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the size of the encoded data or an error code if data is invalid. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>true iff the current node was changed </dd></dl>
</div>
</div>
-<a class="anchor" id="ga1093449b80357dabf3f70a4bf804f4f7"></a>
+<a id="ga1093449b80357dabf3f70a4bf804f4f7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga1093449b80357dabf3f70a4bf804f4f7">◆ </a></span>pn_data_enter()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -721,16 +662,18 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the pointers to the current/parent nodes are changed </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="send_8c-example.html#a12">send.c</a>.</dd>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_8c-example.html#a14">direct.c</a>, and <a class="el" href="send_8c-example.html#a14">send.c</a>.</dd>
</dl>
</div>
</div>
-<a class="anchor" id="ga68e94dfa5d7ab568425c4a6587bac1db"></a>
+<a id="ga67a656cbdbf0a47a223ff1c8507ecf48"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga67a656cbdbf0a47a223ff1c8507ecf48">◆ </a></span>pn_data_exit()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int pn_data_errno </td>
+ <td class="memname">bool pn_data_exit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -739,23 +682,27 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Access the current error code for a given pn_data_t. </p>
+<p>Sets the current node to the parent node and the parent node to its own parent. </p>
+<p>This operation will return false if there is no current node or parent node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the current error code </dd></dl>
-
+<dl class="section return"><dt>Returns</dt><dd>true iff the pointers to the current/parent nodes are changed </dd></dl>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_8c-example.html#a17">direct.c</a>, and <a class="el" href="send_8c-example.html#a17">send.c</a>.</dd>
+</dl>
</div>
</div>
-<a class="anchor" id="gada171f4740e6a1132b4d4b9c0aea645c"></a>
+<a id="ga2843b707e33437a8673e8b904c8faea1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga2843b707e33437a8673e8b904c8faea1">◆ </a></span>pn_data_type()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>* pn_data_error </td>
+ <td class="memname"><a class="el" href="group__amqp__types.html#ga4465b5ea7d3c4f15c1dffa4deda905db">pn_type_t</a> pn_data_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -764,24 +711,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Access the current error for a givn pn_data_t. </p>
-<p>Every pn_data_t has an error descriptor that is created with the pn_data_t and dies with the pn_data_t. The error descriptor is updated whenever an operation fails. The <a class="el" href="group__data.html#gada171f4740e6a1132b4d4b9c0aea645c" title="Access the current error for a givn pn_data_t. ">pn_data_error()</a> function may be used to access a pn_data_t's error descriptor.</p>
+<p>Access the type of the current node. </p>
+<p>Returns PN_INVALID if there is no current node.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">data</td><td>a data object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>a pointer to the pn_data_t's error descriptor </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>the type of the current node </dd></dl>
</div>
</div>
-<a class="anchor" id="ga67a656cbdbf0a47a223ff1c8507ecf48"></a>
+<a id="gaaf46509788aba824bb16343b566f1929"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaaf46509788aba824bb16343b566f1929">◆ </a></span>pn_data_print()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">bool pn_data_exit </td>
+ <td class="memname">int pn_data_print </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -790,20 +739,20 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Sets the current node to the parent node and the parent node to its own parent. </p>
-<p>This operation will return false if there is no current node or parent node.</p>
+<p>Prints the contents of a pn_data_t object using <a class="el" href="group__data.html#gaa63068cf2ed94f05b20f6c49c908a2c6" title="Formats the contents of a pn_data_t object in a human readable way and writes them to the indicated l...">pn_data_format()</a> to stdout. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data object </td></tr>
+ <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>true iff the pointers to the current/parent nodes are changed </dd></dl>
-<dl><dt><b>Examples: </b></dt><dd><a class="el" href="send_8c-example.html#a15">send.c</a>.</dd>
-</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error on failure </dd></dl>
+
</div>
</div>
-<a class="anchor" id="gaa63068cf2ed94f05b20f6c49c908a2c6"></a>
+<a id="gaa63068cf2ed94f05b20f6c49c908a2c6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaa63068cf2ed94f05b20f6c49c908a2c6">◆ </a></span>pn_data_format()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -847,36 +796,59 @@ Functions</h2></td></tr>
</div>
</div>
-<a class="anchor" id="ga2c02eee58084ba9b77a37c086e195802"></a>
+<a id="ga5502724bcde68615bc47e09a3335b527"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga5502724bcde68615bc47e09a3335b527">◆ </a></span>pn_data_encode()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">void pn_data_free </td>
+ <td class="memname">ssize_t pn_data_encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">char * </td>
+ <td class="paramname"><em>bytes</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">size_t </td>
+ <td class="paramname"><em>size</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>Free a pn_data_t object. </p>
+<p>Writes the contents of a data object to the given buffer as an AMQP data stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object or NULL </td></tr>
+ <tr><td class="paramname">data</td><td>the data object to encode </td></tr>
+ <tr><td class="paramname">bytes</td><td>the buffer for encoded data </td></tr>
+ <tr><td class="paramname">size</td><td>the size of the buffer</td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>the size of the encoded data on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gab0f8eefe5f89362ffe186a092044d936"></a>
+<a id="gae71bfb440cc4f0b15fe958bf55a3f6af"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gae71bfb440cc4f0b15fe958bf55a3f6af">◆ </a></span>pn_data_encoded_size()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">size_t pn_data_get_array </td>
+ <td class="memname">ssize_t pn_data_encoded_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -885,49 +857,72 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>If the current node is an array, return the number of elements in the array, otherwise return 0. </p>
-<p>Array data can be accessed by entering the array. If the array is described, the first child node will be the descriptor, and the remaining count child nodes will be the elements of the array.</p>
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> ...</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> size_t count = pn_data_get_array(data);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> bool described = pn_data_is_array_described(data);</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> pn_type_t type = pn_data_get_array_type(data);</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> pn_data_enter(data);</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> if (described && pn_data_next(data)) {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  // the descriptor
could be another type, but let's assume it's a symbol</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  pn_bytes_t descriptor = pn_data_get_symbol(data);</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> }</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> for (size_t i = 0; i < count; i++) {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  if (pn_data_next(data)) {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  // all elements will be values of the array type retrieved above</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  ...</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  }</div><div class="line"><a name="l00018"></a><span class="lin
eno"> 18</span> }</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> pn_data_exit(data);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> ...</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
+<p>Returns the number of bytes needed to encode a data object. </p>
+<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">data</td><td>the data object</td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the number of elements of an array node </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>the size of the encoded data or an error code if data is invalid. </dd></dl>
</div>
</div>
-<a class="anchor" id="ga11c026fb5ec5e8620258f52ed86229b4"></a>
+<a id="ga74430b712be334a05861cfd5e9b312b9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga74430b712be334a05861cfd5e9b312b9">◆ </a></span>pn_data_decode()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#ga4465b5ea7d3c4f15c1dffa4deda905db">pn_type_t</a> pn_data_get_array_type </td>
+ <td class="memname">ssize_t pn_data_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">const char * </td>
+ <td class="paramname"><em>bytes</em>, </td>
</tr>
- </table>
-</div><div class="memdoc">
-
-<p>Return the array type if the current node points to an array, PN_INVALID otherwise. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">size_t </td>
+ <td class="paramname"><em>size</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Decodes a single value from the contents of the AMQP data stream into the current data object. </p>
+<p>Note that if the pn_data_t object is pointing to a current node, the decoded value will overwrite the current one. If the pn_data_t object has no current node then a node will be appended to the current parent. If there is no current parent then a node will be appended to the pn_data_t itself.</p>
+<p>Upon success, this operation returns the number of bytes consumed from the AMQP data stream. Upon failure, this operation returns an error code.</p>
+<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">bytes</td><td>a pointer to an encoded AMQP data stream </td></tr>
+ <tr><td class="paramname">size</td><td>the size of the encoded AMQP data stream </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the element type of an array node </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>the number of bytes consumed from the AMQP data stream or an error code </dd></dl>
</div>
</div>
-<a class="anchor" id="gac5d5c6e6bf24597caf63d35b1755e646"></a>
+<a id="ga95c0c0750831ee3b8454af8bc51a787b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga95c0c0750831ee3b8454af8bc51a787b">◆ </a></span>pn_data_put_list()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__api__types.html#structpn__atom__t">pn_atom_t</a> pn_data_get_atom </td>
+ <td class="memname">int pn_data_put_list </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -936,23 +931,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a scalar value, return it as a <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a>. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Puts an empty list value into a pn_data_t. </p>
+<p>Elements may be filled by entering the list node using <a class="el" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7" title="Sets the parent node to the current node and clears the current node. ">pn_data_enter()</a> and using pn_data_put_* to add the desired contents. Once done, <a class="el" href="group__data.html#ga67a656cbdbf0a47a223ff1c8507ecf48" title="Sets the current node to the parent node and the parent node to its own parent. ">pn_data_exit()</a> may be used to return to the current level in the tree and put more values.</p>
+<div class="fragment"><div class="line"><a class="code" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data = <a class="code" href="group__data.html#gac21c6f1c517ac486e2923baa3d0c5db4">pn_data</a>(0);</div><div class="line">...</div><div class="line">pn_data_put_list(data);</div><div class="line"><a class="code" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7">pn_data_enter</a>(data);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 1);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 2);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 3);</div><div class="line"><a class="code" href="group__data.html#ga67a656cbdbf0a47a223ff1c8507ecf48">pn_data_exit</a>(data);</div><div class="line">...</div></div><!-- fragment --><dl class="
params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the value of the current node as <a class="el" href="group__api__types.html#structpn__atom__t" title="A descriminated union that holds any scalar AMQP value. ">pn_atom_t</a> </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gaee6e7a4f78d202cc81657e3976fd68ae"></a>
+<a id="ga4c77c7a884bbd9a757b31060962d8543"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga4c77c7a884bbd9a757b31060962d8543">◆ </a></span>pn_data_put_map()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> pn_data_get_binary </td>
+ <td class="memname">int pn_data_put_map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -961,47 +959,73 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>If the current node is binary, returns its value, returns "" otherwise. </p>
-<p>The <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> returned will point to memory held inside the pn_data_t. When the pn_data_t is cleared or freed, this memory will be reclaimed.</p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Puts an empty map value into a pn_data_t. </p>
+<p>Elements may be filled by entering the map node and putting alternating key value pairs.</p>
+<div class="fragment"><div class="line"><a class="code" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data = <a class="code" href="group__data.html#gac21c6f1c517ac486e2923baa3d0c5db4">pn_data</a>(0);</div><div class="line">...</div><div class="line">pn_data_put_map(data);</div><div class="line"><a class="code" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7">pn_data_enter</a>(data);</div><div class="line"><a class="code" href="group__data.html#ga5dc9c9c7db2018d12753767c075cc6ee">pn_data_put_string</a>(data, <a class="code" href="group__api__types.html#gab4f7e8d204246a3702c6e31a404b0edb">pn_bytes</a>(3, <span class="stringliteral">"key"</span>));</div><div class="line"><a class="code" href="group__data.html#ga5dc9c9c7db2018d12753767c075cc6ee">pn_data_put_string</a>(data, <a class="code" href="group__api__types.html#gab4f7e8d204246a3702c6e31a404b0edb">pn_bytes</a>(5, <span class="stringliteral">"value"</span>));</div><div class
="line"><a class="code" href="group__data.html#ga67a656cbdbf0a47a223ff1c8507ecf48">pn_data_exit</a>(data);</div><div class="line">...</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_8c-example.html#a13">direct.c</a>, and <a class="el" href="send_8c-example.html#a13">send.c</a>.</dd>
+</dl>
</div>
</div>
-<a class="anchor" id="gaeab50c7bd297665714861cfcb8f51124"></a>
+<a id="ga20dda5db37c55c12b28e428c311b79da"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga20dda5db37c55c12b28e428c311b79da">◆ </a></span>pn_data_put_array()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">bool pn_data_get_bool </td>
+ <td class="memname">int pn_data_put_array </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">bool </td>
+ <td class="paramname"><em>described</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#ga4465b5ea7d3c4f15c1dffa4deda905db">pn_type_t</a> </td>
+ <td class="paramname"><em>type</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba2d6444a931a66258de3c73ad01238ae7" title="The boolean AMQP type. ">PN_BOOL</a>, returns its value. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Puts an empty array value into a pn_data_t. </p>
+<p>Elements may be filled by entering the array node and putting the element values. The values must all be of the specified array element type. If an array is described then the first child value of the array is the descriptor and may be of any type.</p>
+<div class="fragment"><div class="line"><a class="code" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data = <a class="code" href="group__data.html#gac21c6f1c517ac486e2923baa3d0c5db4">pn_data</a>(0);</div><div class="line">...</div><div class="line">pn_data_put_array(data, <span class="keyword">false</span>, <a class="code" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba175c594857c135ea2a9c3a2d415366ab">PN_INT</a>);</div><div class="line"><a class="code" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7">pn_data_enter</a>(data);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 1);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 2);</div><div class="line"><a class="code" href="group__data.html#ga6cfb9e64b87f8d90a5b4237ca016a016">pn_data_put_int</a>(data, 3);</div><div class="line">
<a class="code" href="group__data.html#ga67a656cbdbf0a47a223ff1c8507ecf48">pn_data_exit</a>(data);</div><div class="line">...</div><div class="line">pn_data_put_array(data, True, Data.DOUBLE);</div><div class="line"><a class="code" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7">pn_data_enter</a>(data);</div><div class="line"><a class="code" href="group__data.html#ga00126d993e32a202c34f912d57b8e5ce">pn_data_put_symbol</a>(data, <span class="stringliteral">"array-descriptor"</span>);</div><div class="line"><a class="code" href="group__data.html#ga121070d2c21ef594f1cfe4083677f1a2">pn_data_put_double</a>(data, 1.1);</div><div class="line"><a class="code" href="group__data.html#ga121070d2c21ef594f1cfe4083677f1a2">pn_data_put_double</a>(data, 1.2);</div><div class="line"><a class="code" href="group__data.html#ga121070d2c21ef594f1cfe4083677f1a2">pn_data_put_double</a>(data, 1.3);</div><div class="line"><a class="code" href="group__data.html#ga67a656cbdbf0a47a223ff1c85
07ecf48">pn_data_exit</a>(data);</div><div class="line">...</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">described</td><td>specifies whether the array is described </td></tr>
+ <tr><td class="paramname">type</td><td>the type of the array</td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gaa756be79ecfab947ecea57ed8a9089f7"></a>
+<a id="ga7490c3ee3444557fba3c7ad92e0f0d77"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga7490c3ee3444557fba3c7ad92e0f0d77">◆ </a></span>pn_data_put_described()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int8_t pn_data_get_byte </td>
+ <td class="memname">int pn_data_put_described </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -1010,22 +1034,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a signed byte, returns its value, returns 0 otherwise. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Puts a described value into a pn_data_t object. </p>
+<p>A described node has two children, the descriptor and the value. These are specified by entering the node and putting the desired values.</p>
+<div class="fragment"><div class="line"><a class="code" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *data = <a class="code" href="group__data.html#gac21c6f1c517ac486e2923baa3d0c5db4">pn_data</a>(0);</div><div class="line">...</div><div class="line">pn_data_put_described(data);</div><div class="line"><a class="code" href="group__data.html#ga1093449b80357dabf3f70a4bf804f4f7">pn_data_enter</a>(data);</div><div class="line"><a class="code" href="group__data.html#ga00126d993e32a202c34f912d57b8e5ce">pn_data_put_symbol</a>(data, <a class="code" href="group__api__types.html#gab4f7e8d204246a3702c6e31a404b0edb">pn_bytes</a>(16, <span class="stringliteral">"value-descriptor"</span>));</div><div class="line"><a class="code" href="group__data.html#ga5dc9c9c7db2018d12753767c075cc6ee">pn_data_put_string</a>(data, <a class="code" href="group__api__types.html#gab4f7e8d204246a3702c6e31a404b0edb">pn_bytes</a>(9, <span class="stringliteral">"the value"</
span>));</div><div class="line"><a class="code" href="group__data.html#ga67a656cbdbf0a47a223ff1c8507ecf48">pn_data_exit</a>(data);</div><div class="line">...</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gad03a049653bec28d20dc7587f7e544de"></a>
+<a id="gaf76476c18ae09c520a3ae01eaa62cc92"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaf76476c18ae09c520a3ae01eaa62cc92">◆ </a></span>pn_data_put_null()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> pn_data_get_bytes </td>
+ <td class="memname">int pn_data_put_null </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
<td class="paramname"><em>data</em></td><td>)</td>
@@ -1034,540 +1062,828 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a symbol, string, or binary, return the bytes representing its value. </p>
-<p>The <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> returned will point to memory held inside the pn_data_t. When the pn_data_t is cleared or freed, this memory will be reclaimed.</p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbaee48efaa3cb0c5b5d16c5b869b7e8fbe" title="The NULL AMQP type. ">PN_NULL</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> pointing to the node's value </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga9deeb028b90df8bfa3cad7928348b46b"></a>
+<a id="ga4a35f7001de91101d78143e4e98e6556"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga4a35f7001de91101d78143e4e98e6556">◆ </a></span>pn_data_put_bool()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#gaa1713f25d484600197d2a25ace856672">pn_char_t</a> pn_data_get_char </td>
+ <td class="memname">int pn_data_put_bool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool </td>
+ <td class="paramname"><em>b</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a char, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba2d6444a931a66258de3c73ad01238ae7" title="The boolean AMQP type. ">PN_BOOL</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">b</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gaeb8b424245ca352fb63dce8ca03cd8da"></a>
+<a id="ga49df9ede673853123d84861c169d6113"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga49df9ede673853123d84861c169d6113">◆ </a></span>pn_data_put_ubyte()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#structpn__decimal128__t">pn_decimal128_t</a> pn_data_get_decimal128 </td>
+ <td class="memname">int pn_data_put_ubyte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">uint8_t </td>
+ <td class="paramname"><em>ub</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a decimal128, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba99223ec8d1ae5d915a1eaa7e8fef0256" title="The unsigned byte AMQP type. ">PN_UBYTE</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">ub</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gabdbfa1e913c490d3b1ad6ca169910482"></a>
+<a id="ga182347d1d444bf6290b39239c4c13d0f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga182347d1d444bf6290b39239c4c13d0f">◆ </a></span>pn_data_put_byte()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#ga54d49ca7ff04ad10a57139c2d61f1d44">pn_decimal32_t</a> pn_data_get_decimal32 </td>
+ <td class="memname">int pn_data_put_byte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int8_t </td>
+ <td class="paramname"><em>b</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a decimal32, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba32d7a9a461945791cb02902af9ff6592" title="The byte AMQP type. ">PN_BYTE</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">b</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga3bdeb99d1275d7fe06a46818467d03d9"></a>
+<a id="ga9b5888f354a3a3b084c74186ed59284c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga9b5888f354a3a3b084c74186ed59284c">◆ </a></span>pn_data_put_ushort()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#ga7d8110bc953738d83ad8b9c543ef517f">pn_decimal64_t</a> pn_data_get_decimal64 </td>
+ <td class="memname">int pn_data_put_ushort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t </td>
+ <td class="paramname"><em>us</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a decimal64, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba657a836a5ee74d9468924982ba3a3b41" title="The unsigned short AMQP type. ">PN_USHORT</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">us</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga97c448c037e34404df782c82d77b2bc3"></a>
+<a id="gab230cca5089c6c28c4c12d507513fde9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gab230cca5089c6c28c4c12d507513fde9">◆ </a></span>pn_data_put_short()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">double pn_data_get_double </td>
+ <td class="memname">int pn_data_put_short </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">int16_t </td>
+ <td class="paramname"><em>s</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a double, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba3dbf1221e02329a7f41b41e597833d97" title="The short AMQP type. ">PN_SHORT</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">s</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gabf41ef79c9a4f7e3fd673b0999e63a41"></a>
+<a id="ga549ee35ecd73ac55e9e8aa196a6ba2ec"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga549ee35ecd73ac55e9e8aa196a6ba2ec">◆ </a></span>pn_data_put_uint()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">float pn_data_get_float </td>
+ <td class="memname">int pn_data_put_uint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint32_t </td>
+ <td class="paramname"><em>ui</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a float, returns its value, raises 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbaa7a251ed9fe5c31f0473976467bfefdd" title="The unsigned int AMQP type. ">PN_UINT</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">ui</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga4f9ccacd002e89127b278703a6c680da"></a>
+<a id="ga6cfb9e64b87f8d90a5b4237ca016a016"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga6cfb9e64b87f8d90a5b4237ca016a016">◆ </a></span>pn_data_put_int()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int32_t pn_data_get_int </td>
+ <td class="memname">int pn_data_put_int </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int32_t </td>
+ <td class="paramname"><em>i</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a signed int, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba175c594857c135ea2a9c3a2d415366ab" title="The signed int AMQP type. ">PN_INT</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">i</td><td>the value </td></tr>
</table>
</dd>
</dl>
-
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_8c-example.html#a10">direct.c</a>, and <a class="el" href="send_8c-example.html#a10">send.c</a>.</dd>
+</dl>
</div>
</div>
-<a class="anchor" id="ga3af18fc419995766f83a4b4ac07c31ce"></a>
+<a id="gad406a4cf5bbc22b47cae78954b44c9ef"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gad406a4cf5bbc22b47cae78954b44c9ef">◆ </a></span>pn_data_put_char()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">size_t pn_data_get_list </td>
+ <td class="memname">int pn_data_put_char </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#gaa1713f25d484600197d2a25ace856672">pn_char_t</a> </td>
+ <td class="paramname"><em>c</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a list, return the number of elements, otherwise return zero. </p>
-<p>List elements can be accessed by entering the list.</p>
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> ...</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> size_t count = pn_data_get_list(data);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> pn_data_enter(data);</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> for (size_t i = 0; i < count; i++) {</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  if (pn_data_next(data)) {</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  switch (pn_data_type(data)) {</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  case PN_STRING:</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  ...</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  break;</div><div clas
s="line"><a name="l00010"></a><span class="lineno"> 10</span>  case PN_INT:</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  ...</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  break;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  }</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> }</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> pn_data_exit(data);</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> ...</div></div><!-- fragment --><p> .* </p><dl class="params"><dt>Parameters</dt><dd>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba905512ea57a64d4e2aecf4877b192124" title="The char AMQP type. ">PN_CHAR</a> value. </p>
+<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">c</td><td>the value </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the size of a list node </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga8d813db46df4e635b1ab2c400403560c"></a>
+<a id="gacc4bf3683c8234a94bca8af3ced8c875"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gacc4bf3683c8234a94bca8af3ced8c875">◆ </a></span>pn_data_put_ulong()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int64_t pn_data_get_long </td>
+ <td class="memname">int pn_data_put_ulong </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype">uint64_t </td>
+ <td class="paramname"><em>ul</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is an signed long, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba5f6b5fd2edbedf3f21285b69b8864777" title="The ulong AMQP type. ">PN_ULONG</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">ul</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gadbd4c895a1e10266d20898996ce53bc0"></a>
+<a id="ga90f32862f64d65091d6fb1e7380a672b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga90f32862f64d65091d6fb1e7380a672b">◆ </a></span>pn_data_put_long()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">size_t pn_data_get_map </td>
+ <td class="memname">int pn_data_put_long </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>l</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a map, return the number of child elements, otherwise return zero. </p>
-<p>Key value pairs can be accessed by entering the map.</p>
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> ...</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> size_t count = pn_data_get_map(data);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> pn_data_enter(data);</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> for (size_t i = 0; i < count/2; i++) {</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  // read key</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  if (pn_data_next(data)) {</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  switch (pn_data_type(data)) {</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  case PN_STRING:</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  ...</div><div class="l
ine"><a name="l00010"></a><span class="lineno"> 10</span>  break;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  ...</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  }</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  }</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  ...</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  // read value</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  if (pn_data_next(data)) {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  switch (pn_data_type(data)) {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  case PN_INT:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  ...</div><div class="line"><a name="l0002
0"></a><span class="lineno"> 20</span>  break;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  ...</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  }</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  }</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  ...</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> }</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> pn_data_exit(data);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> ...</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba7a1b08f15b17b3d820a6fb50e65ffe1c" title="The long AMQP type. ">PN_LONG</a> value. </p>
+<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">l</td><td>the value </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>the number of child elements of a map node </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gafe894205eaba01d1caf8ee2aa68ed55c"></a>
+<a id="gacb2c0b2c56d587ee354aaa0f21f2c9b1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gacb2c0b2c56d587ee354aaa0f21f2c9b1">◆ </a></span>pn_data_put_timestamp()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">int16_t pn_data_get_short </td>
+ <td class="memname">int pn_data_put_timestamp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> </td>
+ <td class="paramname"><em>t</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a signed short, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbaca241b4fa6cd92fdf26b4460d02a17b1" title="The timestamp AMQP type. ">PN_TIMESTAMP</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">t</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gafccb5008960eb8dc757cb7f9941e5013"></a>
+<a id="ga1fce9c3194a700eb99552c71651d28fc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga1fce9c3194a700eb99552c71651d28fc">◆ </a></span>pn_data_put_float()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> pn_data_get_string </td>
+ <td class="memname">int pn_data_put_float </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">float </td>
+ <td class="paramname"><em>f</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a string, returns its value, returns "" otherwise. </p>
-<p>The <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> returned will point to memory held inside the pn_data_t. When the pn_data_t is cleared or freed, this memory will be reclaimed.</p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba9c27cba605584c7d093f26e7270bfaa0" title="The float AMQP type. ">PN_FLOAT</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">f</td><td>the value </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> pointing to utf8 </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga3c64a188867ebb19c8d4e3908e6f8e20"></a>
+<a id="ga121070d2c21ef594f1cfe4083677f1a2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga121070d2c21ef594f1cfe4083677f1a2">◆ </a></span>pn_data_put_double()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> pn_data_get_symbol </td>
+ <td class="memname">int pn_data_put_double </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">double </td>
+ <td class="paramname"><em>d</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a symbol, returns its value, returns "" otherwise. </p>
-<p>The <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> returned will point to memory held inside the pn_data_t. When the pn_data_t is cleared or freed, this memory will be reclaimed.</p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbaa1367e8029855849dc4e0d3f027279a5" title="The double AMQP type. ">PN_DOUBLE</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">d</td><td>the value </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> pointing to ascii </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gac8cf4d1cb60c3313f4d61f45bceda5ba"></a>
+<a id="ga0199029f44d9c86e469c15bef51ceea2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga0199029f44d9c86e469c15bef51ceea2">◆ </a></span>pn_data_put_decimal32()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> pn_data_get_timestamp </td>
+ <td class="memname">int pn_data_put_decimal32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#ga54d49ca7ff04ad10a57139c2d61f1d44">pn_decimal32_t</a> </td>
+ <td class="paramname"><em>d</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a timestamp, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbae998dd044ac55b959427fc90531b14ca" title="The decimal32 AMQP type. ">PN_DECIMAL32</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">d</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga7582b8fd0ecdf0368a600b9c4f22faa8"></a>
+<a id="ga7672e15a4925bb14bebb79bc8206d392"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga7672e15a4925bb14bebb79bc8206d392">◆ </a></span>pn_data_put_decimal64()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">uint8_t pn_data_get_ubyte </td>
+ <td class="memname">int pn_data_put_decimal64 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#ga7d8110bc953738d83ad8b9c543ef517f">pn_decimal64_t</a> </td>
+ <td class="paramname"><em>d</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba99223ec8d1ae5d915a1eaa7e8fef0256" title="The unsigned byte AMQP type. ">PN_UBYTE</a>, return its value, otherwise return 0. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbacb54239601b8bf4795e34417425b92ae" title="The decimal64 AMQP type. ">PN_DECIMAL64</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">d</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga9541c1ee071c7d0b38805e1b01672ccc"></a>
+<a id="ga61944d632d27ffc1c0d6348f62bfec4e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga61944d632d27ffc1c0d6348f62bfec4e">◆ </a></span>pn_data_put_decimal128()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">uint32_t pn_data_get_uint </td>
+ <td class="memname">int pn_data_put_decimal128 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#structpn__decimal128__t">pn_decimal128_t</a> </td>
+ <td class="paramname"><em>d</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is an unsigned int, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dbae54cf8095578932042be640555855cd4" title="The decimal128 AMQP type. ">PN_DECIMAL128</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">d</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="gaef4aa1c6873eb59a46ccaf76c492826f"></a>
+<a id="ga5d876ccb1d65d46af7db461d4415baab"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga5d876ccb1d65d46af7db461d4415baab">◆ </a></span>pn_data_put_uuid()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">uint64_t pn_data_get_ulong </td>
+ <td class="memname">int pn_data_put_uuid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__amqp__types.html#structpn__uuid__t">pn_uuid_t</a> </td>
+ <td class="paramname"><em>u</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is an unsigned long, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba0a6946e5c032bae8d108100e2c56ac13" title="The UUID AMQP type. ">PN_UUID</a> value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">u</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga254abc4df02a5c2e87fd3bdac2e14846"></a>
+<a id="gaeddd7cf9d968e81ebe72831330e7cd21"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#gaeddd7cf9d968e81ebe72831330e7cd21">◆ </a></span>pn_data_put_binary()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">uint16_t pn_data_get_ushort </td>
+ <td class="memname">int pn_data_put_binary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
<td></td>
+ <td class="paramtype"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> </td>
+ <td class="paramname"><em>bytes</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is an unsigned short, returns its value, returns 0 otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba7dc0fd4874c2b57a8249614d348643e9" title="The binary AMQP type. ">PN_BINARY</a> value. </p>
+<p>The bytes referenced by the <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> argument are copied and stored inside the pn_data_t object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">bytes</td><td>the value </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
</div>
</div>
-<a class="anchor" id="ga5ba3f8eb5a972b9a579bc5af9e7fbde2"></a>
+<a id="ga5dc9c9c7db2018d12753767c075cc6ee"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga5dc9c9c7db2018d12753767c075cc6ee">◆ </a></span>pn_data_put_string()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname"><a class="el" href="group__amqp__types.html#structpn__uuid__t">pn_uuid_t</a> pn_data_get_uuid </td>
+ <td class="memname">int pn_data_put_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td>
- <td class="paramname"><em>data</em></td><td>)</td>
+ <td class="paramname"><em>data</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> </td>
+ <td class="paramname"><em>string</em> </td>
+ </tr>
+ <tr>
<td></td>
+ <td>)</td>
+ <td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
-<p>If the current node is a UUID, returns its value, returns None otherwise. </p>
+<p>Puts a <a class="el" href="group__amqp__types.html#gga4465b5ea7d3c4f15c1dffa4deda905dba88421417c7be2caf88c2d243cb73da6b" title="The string AMQP type. ">PN_STRING</a> value. </p>
+<p>The bytes referenced by the <a class="el" href="group__api__types.html#structpn__bytes__t" title="A const byte buffer. ">pn_bytes_t</a> argument are copied and stored inside the pn_data_t object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pn_data_t object </td></tr>
+ <tr><td class="paramname">string</td><td>utf8 encoded unicode </td></tr>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>a uuid value </dd></dl>
-
+<dl class="section return"><dt>Returns</dt><dd>zero on success or an error code on failure </dd></dl>
+<dl><dt><b>Examples: </b></dt><dd><a class="el" href="direct_8c-example.html#a15">direct.c</a>, and <a class="el" href="send_8c-example.html#a15">send.c</a>.</dd>
+</dl>
</div>
</div>
-<a class="anchor" id="ga122e7f20f958d51900675d37d80bd37e"></a>
+<a id="ga00126d993e32a202c34f912d57b8e5ce"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga00126d993e32a202c34f912d57b8e5ce">◆ </a></span>pn_data_put_symbol()</h2>
+
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
-
<TRUNCATED>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org