Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / input / releases / qpid-proton-0.32.0 / proton / c / api / group__api__types.html
blob: d4201612772b72ce0694a3367f28ab6cdd27244f [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: API data types</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('group__api__types.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="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">API data types<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Additional data types used in the API.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:structpn__atom__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#structpn__atom__t">pn_atom_t</a></td></tr>
<tr class="memdesc:structpn__atom__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">A discriminated union that holds any scalar AMQP value. <a href="group__api__types.html#structpn__atom__t">More...</a><br /></td></tr>
<tr class="separator:structpn__atom__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structpn__bytes__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a></td></tr>
<tr class="memdesc:structpn__bytes__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">A const byte buffer. <a href="group__api__types.html#structpn__bytes__t">More...</a><br /></td></tr>
<tr class="separator:structpn__bytes__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structpn__rwbytes__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a></td></tr>
<tr class="memdesc:structpn__rwbytes__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">A non-const byte buffer. <a href="group__api__types.html#structpn__rwbytes__t">More...</a><br /></td></tr>
<tr class="separator:structpn__rwbytes__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga46d74369b8b364df95fd7cfa843f6d64"><td class="memItemLeft" align="right" valign="top"><a id="ga46d74369b8b364df95fd7cfa843f6d64"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#ga46d74369b8b364df95fd7cfa843f6d64">PN_MILLIS_MAX</a></td></tr>
<tr class="memdesc:ga46d74369b8b364df95fd7cfa843f6d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum value for <a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a>. <br /></td></tr>
<tr class="separator:ga46d74369b8b364df95fd7cfa843f6d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0aa3ebc7c0f1f273a874dcb1553ccb0f"><td class="memItemLeft" align="right" valign="top"><a id="ga0aa3ebc7c0f1f273a874dcb1553ccb0f"></a>
typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#ga0aa3ebc7c0f1f273a874dcb1553ccb0f">pn_sequence_t</a></td></tr>
<tr class="memdesc:ga0aa3ebc7c0f1f273a874dcb1553ccb0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A sequence number. <br /></td></tr>
<tr class="separator:ga0aa3ebc7c0f1f273a874dcb1553ccb0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a701bc6dc9af9f42c3f4679172a723c"><td class="memItemLeft" align="right" valign="top"><a id="ga9a701bc6dc9af9f42c3f4679172a723c"></a>
typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a></td></tr>
<tr class="memdesc:ga9a701bc6dc9af9f42c3f4679172a723c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A span of time in milliseconds. <br /></td></tr>
<tr class="separator:ga9a701bc6dc9af9f42c3f4679172a723c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafdede9be0526a8d0b9ab5d3149069af1"><td class="memItemLeft" align="right" valign="top"><a id="gafdede9be0526a8d0b9ab5d3149069af1"></a>
typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a></td></tr>
<tr class="memdesc:gafdede9be0526a8d0b9ab5d3149069af1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A span of time in seconds. <br /></td></tr>
<tr class="separator:gafdede9be0526a8d0b9ab5d3149069af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab4f7e8d204246a3702c6e31a404b0edb"><td class="memItemLeft" align="right" valign="top"><a id="gab4f7e8d204246a3702c6e31a404b0edb"></a>
<a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#gab4f7e8d204246a3702c6e31a404b0edb">pn_bytes</a> (size_t size, const char *start)</td></tr>
<tr class="memdesc:gab4f7e8d204246a3702c6e31a404b0edb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a>. <br /></td></tr>
<tr class="separator:gab4f7e8d204246a3702c6e31a404b0edb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9fb5bee0255a52b1b8b8fa1b8620cbca"><td class="memItemLeft" align="right" valign="top"><a id="ga9fb5bee0255a52b1b8b8fa1b8620cbca"></a>
<a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__types.html#ga9fb5bee0255a52b1b8b8fa1b8620cbca">pn_rwbytes</a> (size_t size, char *start)</td></tr>
<tr class="memdesc:ga9fb5bee0255a52b1b8b8fa1b8620cbca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a>. <br /></td></tr>
<tr class="separator:ga9fb5bee0255a52b1b8b8fa1b8620cbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Additional data types used in the API. </p>
<hr/><h2 class="groupheader">Class Documentation</h2>
<a name="structpn__atom__t" id="structpn__atom__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structpn__atom__t">&#9670;&nbsp;</a></span>pn_atom_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct pn_atom_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>A discriminated union that holds any scalar AMQP value. </p>
<p>The type field indicates the AMQP type of the value, and the union may be used to access the value for a given type. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a id="a27df760d7bd97cf728fc3e633a1ba604"></a><a class="el" href="group__amqp__types.html#ga4465b5ea7d3c4f15c1dffa4deda905db">pn_type_t</a></td>
<td class="fieldname">
type</td>
<td class="fielddoc">
Indicates the type of value the atom is currently pointing to. <p>See <a class="el" href="group__amqp__types.html#ga4465b5ea7d3c4f15c1dffa4deda905db" title="Identifies an AMQP type.">pn_type_t</a> for details on AMQP types. </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a6bbdd696540adf79b8b43482fd928bce"></a>union <a class="el" href="group__api__types.html#unionpn__atom__t_8u">pn_atom_t</a></td>
<td class="fieldname">
u</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structpn__bytes__t" id="structpn__bytes__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structpn__bytes__t">&#9670;&nbsp;</a></span>pn_bytes_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct pn_bytes_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>A const byte buffer. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a id="a854352f53b148adc24983a58a1866d66"></a>size_t</td>
<td class="fieldname">
size</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="ac621bcfb466f3b6a6421c5f48b30ade3"></a>const char *</td>
<td class="fieldname">
start</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structpn__rwbytes__t" id="structpn__rwbytes__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structpn__rwbytes__t">&#9670;&nbsp;</a></span>pn_rwbytes_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct pn_rwbytes_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>A non-const byte buffer. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8c-example.html#_a0">broker.c</a>, <a class="el" href="direct_8c-example.html#_a0">direct.c</a>, <a class="el" href="receive_8c-example.html#_a0">receive.c</a>, and <a class="el" href="send_8c-example.html#_a0">send.c</a>.</dd>
</dl>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a id="a854352f53b148adc24983a58a1866d66"></a>size_t</td>
<td class="fieldname">
size</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="ab40328f79e021050ac262dc0a6019667"></a>char *</td>
<td class="fieldname">
start</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>