| <!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: Connection driver</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&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 |
|  <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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('group__connection__driver.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> | |
| <a href="#define-members">Macros</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Connection driver<div class="ingroups"><a class="el" href="group__io.html">IO</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><b>Unsettled API</b> - An API for low-level IO integration. |
| <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__connection__driver__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a></td></tr> |
| <tr class="memdesc:structpn__connection__driver__t"><td class="mdescLeft"> </td><td class="mdescRight">The elements needed to drive AMQP IO and events. <a href="group__connection__driver.html#structpn__connection__driver__t">More...</a><br /></td></tr> |
| <tr class="separator:structpn__connection__driver__t"><td class="memSeparator" colspan="2"> </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:ga56e55c7d0343529b7fb3002b930a36b2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga56e55c7d0343529b7fb3002b930a36b2">PN_TRANSPORT_WRITE_CLOSED</a></td></tr> |
| <tr class="memdesc:ga56e55c7d0343529b7fb3002b930a36b2"><td class="mdescLeft"> </td><td class="mdescRight">The write side of the transport is closed, it will no longer produce bytes to write to external IO. <a href="group__connection__driver.html#ga56e55c7d0343529b7fb3002b930a36b2">More...</a><br /></td></tr> |
| <tr class="separator:ga56e55c7d0343529b7fb3002b930a36b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9a331416719994f6cb0971acce5208fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga9a331416719994f6cb0971acce5208fb">PN_TRANSPORT_READ_CLOSED</a></td></tr> |
| <tr class="memdesc:ga9a331416719994f6cb0971acce5208fb"><td class="mdescLeft"> </td><td class="mdescRight">The read side of the transport is closed, it will no longer read bytes from external IO. <a href="group__connection__driver.html#ga9a331416719994f6cb0971acce5208fb">More...</a><br /></td></tr> |
| <tr class="separator:ga9a331416719994f6cb0971acce5208fb"><td class="memSeparator" colspan="2"> </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:ga2330d329e295da740ef8d126657470c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga2330d329e295da740ef8d126657470c6">pn_connection_driver_init</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *, <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *)</td></tr> |
| <tr class="memdesc:ga2330d329e295da740ef8d126657470c6"><td class="mdescLeft"> </td><td class="mdescRight">Set connection and transport to the provided values, or create a new <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> or <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> if either is NULL. <a href="group__connection__driver.html#ga2330d329e295da740ef8d126657470c6">More...</a><br /></td></tr> |
| <tr class="separator:ga2330d329e295da740ef8d126657470c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad2bdef0f5abe7cf593afcee237c6af56"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gad2bdef0f5abe7cf593afcee237c6af56">pn_connection_driver_bind</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d)</td></tr> |
| <tr class="memdesc:gad2bdef0f5abe7cf593afcee237c6af56"><td class="mdescLeft"> </td><td class="mdescRight">Force binding of the transport. <a href="group__connection__driver.html#gad2bdef0f5abe7cf593afcee237c6af56">More...</a><br /></td></tr> |
| <tr class="separator:gad2bdef0f5abe7cf593afcee237c6af56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3e8959d7897cd9415f687981c1d94c96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96">pn_connection_driver_destroy</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga3e8959d7897cd9415f687981c1d94c96"><td class="mdescLeft"> </td><td class="mdescRight">Unbind, release and free the connection and transport. <a href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96">More...</a><br /></td></tr> |
| <tr class="separator:ga3e8959d7897cd9415f687981c1d94c96"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga96a6bf8efc2dd7b76734cb2432441333"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga96a6bf8efc2dd7b76734cb2432441333">pn_connection_driver_release_connection</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d)</td></tr> |
| <tr class="memdesc:ga96a6bf8efc2dd7b76734cb2432441333"><td class="mdescLeft"> </td><td class="mdescRight">Disassociate the driver's connection from its transport and collector and sets d->connection = NULL. <a href="group__connection__driver.html#ga96a6bf8efc2dd7b76734cb2432441333">More...</a><br /></td></tr> |
| <tr class="separator:ga96a6bf8efc2dd7b76734cb2432441333"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0dd152968de6ec06de352e1cbc51c438"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438">pn_connection_driver_read_buffer</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga0dd152968de6ec06de352e1cbc51c438"><td class="mdescLeft"> </td><td class="mdescRight">Get the read buffer. <a href="group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438">More...</a><br /></td></tr> |
| <tr class="separator:ga0dd152968de6ec06de352e1cbc51c438"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa164510528ce160efddbde2245c438b1"><td class="memItemLeft" align="right" valign="top"><a id="gaa164510528ce160efddbde2245c438b1"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gaa164510528ce160efddbde2245c438b1">pn_connection_driver_read_done</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *, size_t n)</td></tr> |
| <tr class="memdesc:gaa164510528ce160efddbde2245c438b1"><td class="mdescLeft"> </td><td class="mdescRight">Process the first n bytes of data in <a class="el" href="group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438" title="Get the read buffer.">pn_connection_driver_read_buffer()</a> and reclaim the buffer space. <br /></td></tr> |
| <tr class="separator:gaa164510528ce160efddbde2245c438b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga11b59aec2b54acdefd63dfbce8d09a3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga11b59aec2b54acdefd63dfbce8d09a3f">pn_connection_driver_read_close</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga11b59aec2b54acdefd63dfbce8d09a3f"><td class="mdescLeft"> </td><td class="mdescRight">Close the read side. <a href="group__connection__driver.html#ga11b59aec2b54acdefd63dfbce8d09a3f">More...</a><br /></td></tr> |
| <tr class="separator:ga11b59aec2b54acdefd63dfbce8d09a3f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga56ccde529842f18774fdf827e86afa23"><td class="memItemLeft" align="right" valign="top"><a id="ga56ccde529842f18774fdf827e86afa23"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga56ccde529842f18774fdf827e86afa23">pn_connection_driver_read_closed</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga56ccde529842f18774fdf827e86afa23"><td class="mdescLeft"> </td><td class="mdescRight">True if read side is closed. <br /></td></tr> |
| <tr class="separator:ga56ccde529842f18774fdf827e86afa23"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3e5795e14572eec632231fe9f916ca5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga3e5795e14572eec632231fe9f916ca5f">pn_connection_driver_write_buffer</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga3e5795e14572eec632231fe9f916ca5f"><td class="mdescLeft"> </td><td class="mdescRight">Get the write buffer. <a href="group__connection__driver.html#ga3e5795e14572eec632231fe9f916ca5f">More...</a><br /></td></tr> |
| <tr class="separator:ga3e5795e14572eec632231fe9f916ca5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaead42b6a9356214d9e2bb591af009243"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gaead42b6a9356214d9e2bb591af009243">pn_connection_driver_write_done</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *, size_t n)</td></tr> |
| <tr class="memdesc:gaead42b6a9356214d9e2bb591af009243"><td class="mdescLeft"> </td><td class="mdescRight">Call when the first n bytes of <a class="el" href="group__connection__driver.html#ga3e5795e14572eec632231fe9f916ca5f" title="Get the write buffer.">pn_connection_driver_write_buffer()</a> have been written to IO. <a href="group__connection__driver.html#gaead42b6a9356214d9e2bb591af009243">More...</a><br /></td></tr> |
| <tr class="separator:gaead42b6a9356214d9e2bb591af009243"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafdca1cd72d6da760d3df7981085b36ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gafdca1cd72d6da760d3df7981085b36ce">pn_connection_driver_write_close</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:gafdca1cd72d6da760d3df7981085b36ce"><td class="mdescLeft"> </td><td class="mdescRight">Close the write side. <a href="group__connection__driver.html#gafdca1cd72d6da760d3df7981085b36ce">More...</a><br /></td></tr> |
| <tr class="separator:gafdca1cd72d6da760d3df7981085b36ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga001b2f3c1bfe4d24d53b93d79dccbfe3"><td class="memItemLeft" align="right" valign="top"><a id="ga001b2f3c1bfe4d24d53b93d79dccbfe3"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga001b2f3c1bfe4d24d53b93d79dccbfe3">pn_connection_driver_write_closed</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga001b2f3c1bfe4d24d53b93d79dccbfe3"><td class="mdescLeft"> </td><td class="mdescRight">True if write side is closed. <br /></td></tr> |
| <tr class="separator:ga001b2f3c1bfe4d24d53b93d79dccbfe3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="memItemLeft" align="right" valign="top"><a id="gad0c98415e0105efb71e8c1a8c4c1e5fb"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gad0c98415e0105efb71e8c1a8c4c1e5fb">pn_connection_driver_close</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *c)</td></tr> |
| <tr class="memdesc:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="mdescLeft"> </td><td class="mdescRight">Close both sides. <br /></td></tr> |
| <tr class="separator:gad0c98415e0105efb71e8c1a8c4c1e5fb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga00b32ae810a25ba6e172d6ed870982a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5">pn_connection_driver_next_event</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga00b32ae810a25ba6e172d6ed870982a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the next event to handle. <a href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5">More...</a><br /></td></tr> |
| <tr class="separator:ga00b32ae810a25ba6e172d6ed870982a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae51f2124706bb1674e2c623a2dc62da7"><td class="memItemLeft" align="right" valign="top"><a id="gae51f2124706bb1674e2c623a2dc62da7"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gae51f2124706bb1674e2c623a2dc62da7">pn_connection_driver_has_event</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:gae51f2124706bb1674e2c623a2dc62da7"><td class="mdescLeft"> </td><td class="mdescRight">True if <a class="el" href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5" title="Get the next event to handle.">pn_connection_driver_next_event()</a> will return a non-NULL event. <br /></td></tr> |
| <tr class="separator:gae51f2124706bb1674e2c623a2dc62da7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga38f56836858b2d4a04ab961f650950d4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4">pn_connection_driver_finished</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *)</td></tr> |
| <tr class="memdesc:ga38f56836858b2d4a04ab961f650950d4"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the the driver is closed for reading and writing and there are no more events. <a href="group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4">More...</a><br /></td></tr> |
| <tr class="separator:ga38f56836858b2d4a04ab961f650950d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga373eb1f632468582d025f5d6acf9655e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e">pn_connection_driver_errorf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *name, const char *fmt,...)</td></tr> |
| <tr class="memdesc:ga373eb1f632468582d025f5d6acf9655e"><td class="mdescLeft"> </td><td class="mdescRight">Set transport error. <a href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e">More...</a><br /></td></tr> |
| <tr class="separator:ga373eb1f632468582d025f5d6acf9655e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad774f90adceaf86748a0ae781f66daf2"><td class="memItemLeft" align="right" valign="top"><a id="gad774f90adceaf86748a0ae781f66daf2"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gad774f90adceaf86748a0ae781f66daf2">pn_connection_driver_verrorf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *name, const char *fmt, va_list)</td></tr> |
| <tr class="memdesc:gad774f90adceaf86748a0ae781f66daf2"><td class="mdescLeft"> </td><td class="mdescRight">Set transport error via a va_list, see <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set transport error.">pn_connection_driver_errorf()</a> <br /></td></tr> |
| <tr class="separator:gad774f90adceaf86748a0ae781f66daf2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gadb682f03cb66b5898c4b285353e0005e"><td class="memItemLeft" align="right" valign="top"><a id="gadb682f03cb66b5898c4b285353e0005e"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gadb682f03cb66b5898c4b285353e0005e">pn_connection_driver_log</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *msg)</td></tr> |
| <tr class="memdesc:gadb682f03cb66b5898c4b285353e0005e"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#gad603e8d72578bcedd2d9235f74f28f37" title="Log a message using a transport's logging mechanism.">pn_transport_log()</a>. <br /></td></tr> |
| <tr class="separator:gadb682f03cb66b5898c4b285353e0005e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga756d1d7130b79f639d71d331f9005cab"><td class="memItemLeft" align="right" valign="top"><a id="ga756d1d7130b79f639d71d331f9005cab"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#ga756d1d7130b79f639d71d331f9005cab">pn_connection_driver_logf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *fmt,...)</td></tr> |
| <tr class="memdesc:ga756d1d7130b79f639d71d331f9005cab"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#ga26cff9ffda93e2ffc8606e19eefe7f84" title="Log a printf formatted message using a transport's logging mechanism.">pn_transport_logf()</a>. <br /></td></tr> |
| <tr class="separator:ga756d1d7130b79f639d71d331f9005cab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="memItemLeft" align="right" valign="top"><a id="gabf97a6a0b608fd096fcaa4f2692c2c63"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gabf97a6a0b608fd096fcaa4f2692c2c63">pn_connection_driver_vlogf</a> (<a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> *d, const char *fmt, va_list ap)</td></tr> |
| <tr class="memdesc:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__transport.html#gac773c1b9226783f36e2f2d4770e90e3f" title="Log a printf formatted message using a transport's logging mechanism.">pn_transport_vlogf()</a>. <br /></td></tr> |
| <tr class="separator:gabf97a6a0b608fd096fcaa4f2692c2c63"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connection__driver.html#gab9d4f3255c83d7792fc17e5a020ff1c0">pn_connection_driver_ptr</a> (<a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> |
| <tr class="memdesc:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="mdescLeft"> </td><td class="mdescRight">Associate a pn_connection_t with its <a class="el" href="group__connection__driver.html#structpn__connection__driver__t" title="The elements needed to drive AMQP IO and events.">pn_connection_driver_t</a>. <a href="group__connection__driver.html#gab9d4f3255c83d7792fc17e5a020ff1c0">More...</a><br /></td></tr> |
| <tr class="separator:gab9d4f3255c83d7792fc17e5a020ff1c0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <p><b>Unsettled API</b> - An API for low-level IO integration. </p> |
| <p>Associate a <a class="el" href="group__connection.html">Connection</a> and <a class="el" href="group__transport.html">Transport</a> with AMQP byte streams from any source.</p> |
| <ul> |
| <li>process AMQP-encoded bytes from some input byte stream</li> |
| <li>generate <a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8" title="Notification of a state change in the protocol engine.">pn_event_t</a> events for your application to handle</li> |
| <li>encode resulting AMQP output bytes for some output byte stream</li> |
| </ul> |
| <p>The <code>pn_connection_driver_*</code> functions provide a simplified API and extra logic to use <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff" title="An AMQP Connection object.">pn_connection_t</a> and <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8" title="A network channel supporting an AMQP connection.">pn_transport_t</a> as a unit. You can also access them directly for features that do not have <code>pn_connection_driver_*</code> functions.</p> |
| <p>The driver buffers events and data. You should run it until <a class="el" href="group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4" title="Return true if the the driver is closed for reading and writing and there are no more events.">pn_connection_driver_finished()</a> is true, to ensure all reading, writing, and event handling (including <code>ERROR</code> and <code>FINAL</code> events) is finished.</p> |
| <h2><a class="anchor" id="autotoc_md0"></a> |
| Error handling</h2> |
| <p>The <code>pn_connection_driver_*</code> functions do not return an error code. IO errors are set on the transport condition and are returned as a <code>PN_TRANSPORT_ERROR</code>. The integration code can set errors using <a class="el" href="group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e" title="Set transport error.">pn_connection_driver_errorf()</a>.</p> |
| <h2><a class="anchor" id="autotoc_md1"></a> |
| IO patterns</h2> |
| <p>This API supports asynchronous, proactive, non-blocking and reactive IO. An integration does not have to follow the dispatch-read-write sequence above, but note that you should handle all available events before calling <a class="el" href="group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438" title="Get the read buffer.">pn_connection_driver_read_buffer()</a> and check that <code>size</code> is non-zero before starting a blocking or asynchronous read call. A <code>read</code> started while there are unprocessed <code>CLOSE</code> events in the buffer may never complete.</p> |
| <p>AMQP is a full-duplex, asynchronous protocol. The "read" and "write" sides of an AMQP connection can close separately.</p> |
| <h2><a class="anchor" id="autotoc_md2"></a> |
| Thread safety</h2> |
| <p>The <a class="el" href="group__connection__driver.html">Connection driver</a> types are not thread safe, but each connection and its associated types form an independent unit. Different connections can be processed concurrently by different threads. </p> |
| <hr/><h2 class="groupheader">Class Documentation</h2> |
| <a name="structpn__connection__driver__t" id="structpn__connection__driver__t"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#structpn__connection__driver__t">◆ </a></span>pn_connection_driver_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">struct pn_connection_driver_t</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <div class="textblock"><p>The elements needed to drive AMQP IO and events. </p> |
| </div><table class="fieldtable"> |
| <tr><th colspan="3">Class Members</th></tr> |
| <tr><td class="fieldtype"> |
| <a id="a274eb4e9f62c87e615e8f1d0041a6f61"></a><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *</td> |
| <td class="fieldname"> |
| connection</td> |
| <td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldtype"> |
| <a id="aa07ae8b40e8e06ed2e1532c089c4b779"></a><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *</td> |
| <td class="fieldname"> |
| transport</td> |
| <td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldtype"> |
| <a id="a98dc9098e6258677bcb7e87d324858ac"></a><a class="el" href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a> *</td> |
| <td class="fieldname"> |
| collector</td> |
| <td class="fielddoc"> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="ga56e55c7d0343529b7fb3002b930a36b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga56e55c7d0343529b7fb3002b930a36b2">◆ </a></span>PN_TRANSPORT_WRITE_CLOSED</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define PN_TRANSPORT_WRITE_CLOSED</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The write side of the transport is closed, it will no longer produce bytes to write to external IO. </p> |
| <p>Synonym for PN_TRANSPORT_HEAD_CLOSED </p> |
| |
| </div> |
| </div> |
| <a id="ga9a331416719994f6cb0971acce5208fb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9a331416719994f6cb0971acce5208fb">◆ </a></span>PN_TRANSPORT_READ_CLOSED</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define PN_TRANSPORT_READ_CLOSED</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The read side of the transport is closed, it will no longer read bytes from external IO. </p> |
| <p>Alias for PN_TRANSPORT_TAIL_CLOSED </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ga2330d329e295da740ef8d126657470c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga2330d329e295da740ef8d126657470c6">◆ </a></span>pn_connection_driver_init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_connection_driver_init </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname">, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> |
| <td class="paramname">, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> |
| <td class="paramname"> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set connection and transport to the provided values, or create a new <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> or <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> if either is NULL. </p> |
| <p>The provided values belong to the connection driver and will be freed by <a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96" title="Unbind, release and free the connection and transport.">pn_connection_driver_destroy()</a>.</p> |
| <p>The transport is bound automatically after the PN_CONNECTION_INIT has been is handled by the application. It can be bound earlier with <a class="el" href="group__connection__driver.html#gad2bdef0f5abe7cf593afcee237c6af56" title="Force binding of the transport.">pn_connection_driver_bind()</a>.</p> |
| <p>The following functions must be called before the transport is bound to have effect: pn_connection_set_username(), <a class="el" href="group__connection.html#ga8be7fdeb5a229d16e45fa122844fb285" title="Set the authentication password for a client connection.">pn_connection_set_password()</a>, <a class="el" href="group__transport.html#gac5bebd26c0942bc17d7fad36577110f8" title="Configure a transport as a server.">pn_transport_set_server()</a>.</p> |
| <dl class="section return"><dt>Returns</dt><dd>PN_OUT_OF_MEMORY if any allocation fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad2bdef0f5abe7cf593afcee237c6af56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad2bdef0f5abe7cf593afcee237c6af56">◆ </a></span>pn_connection_driver_bind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_connection_driver_bind </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"><em>d</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Force binding of the transport. </p> |
| <p>This happens automatically after the PN_CONNECTION_INIT is processed.</p> |
| <dl class="section return"><dt>Returns</dt><dd>PN_STATE_ERR if the transport is already bound. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga3e8959d7897cd9415f687981c1d94c96"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3e8959d7897cd9415f687981c1d94c96">◆ </a></span>pn_connection_driver_destroy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_connection_driver_destroy </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Unbind, release and free the connection and transport. </p> |
| <p>Set all pointers to NULL. Does not free the <a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> struct itself. </p> |
| |
| </div> |
| </div> |
| <a id="ga96a6bf8efc2dd7b76734cb2432441333"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga96a6bf8efc2dd7b76734cb2432441333">◆ </a></span>pn_connection_driver_release_connection()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>* pn_connection_driver_release_connection </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"><em>d</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Disassociate the driver's connection from its transport and collector and sets d->connection = NULL. </p> |
| <p>Returns the previous value, which must be freed by the caller.</p> |
| <p>The transport and collector are still owned by the driver and will be freed by <a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96" title="Unbind, release and free the connection and transport.">pn_connection_driver_destroy()</a>.</p> |
| <dl class="section note"><dt>Note</dt><dd>This has nothing to do with <a class="el" href="group__connection.html#ga7c88b4833cf81d801b27d00b45d137b5" title="Release a connection object.">pn_connection_release()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga0dd152968de6ec06de352e1cbc51c438"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0dd152968de6ec06de352e1cbc51c438">◆ </a></span>pn_connection_driver_read_buffer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__api__types.html#structpn__rwbytes__t">pn_rwbytes_t</a> pn_connection_driver_read_buffer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the read buffer. </p> |
| <p>Copy data from your input byte source to buf.start, up to buf.size. Call <a class="el" href="group__connection__driver.html#gaa164510528ce160efddbde2245c438b1" title="Process the first n bytes of data in pn_connection_driver_read_buffer() and reclaim the buffer space.">pn_connection_driver_read_done()</a> when reading is complete.</p> |
| <p>buf.size==0 means reading is not possible: no buffer space or the read side is closed. </p> |
| |
| </div> |
| </div> |
| <a id="ga11b59aec2b54acdefd63dfbce8d09a3f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga11b59aec2b54acdefd63dfbce8d09a3f">◆ </a></span>pn_connection_driver_read_close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_connection_driver_read_close </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the read side. </p> |
| <p>Call when the IO can no longer be read. </p> |
| |
| </div> |
| </div> |
| <a id="ga3e5795e14572eec632231fe9f916ca5f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3e5795e14572eec632231fe9f916ca5f">◆ </a></span>pn_connection_driver_write_buffer()</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_connection_driver_write_buffer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the write buffer. </p> |
| <p>Write data from buf.start to your IO destination, up to a max of buf.size. Call <a class="el" href="group__connection__driver.html#gaead42b6a9356214d9e2bb591af009243" title="Call when the first n bytes of pn_connection_driver_write_buffer() have been written to IO.">pn_connection_driver_write_done()</a> when writing is complete.</p> |
| <p>buf.size==0 means there is nothing to write. </p> |
| |
| </div> |
| </div> |
| <a id="gaead42b6a9356214d9e2bb591af009243"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaead42b6a9356214d9e2bb591af009243">◆ </a></span>pn_connection_driver_write_done()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_connection_driver_write_done </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname">, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>n</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Call when the first n bytes of <a class="el" href="group__connection__driver.html#ga3e5795e14572eec632231fe9f916ca5f" title="Get the write buffer.">pn_connection_driver_write_buffer()</a> have been written to IO. </p> |
| <p>Reclaims the buffer space and reset the write buffer. </p> |
| |
| </div> |
| </div> |
| <a id="gafdca1cd72d6da760d3df7981085b36ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gafdca1cd72d6da760d3df7981085b36ce">◆ </a></span>pn_connection_driver_write_close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_connection_driver_write_close </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the write side. </p> |
| <p>Call when IO can no longer be written to. </p> |
| |
| </div> |
| </div> |
| <a id="ga00b32ae810a25ba6e172d6ed870982a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga00b32ae810a25ba6e172d6ed870982a5">◆ </a></span>pn_connection_driver_next_event()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a>* pn_connection_driver_next_event </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the next event to handle. </p> |
| <dl class="section return"><dt>Returns</dt><dd>pointer is valid till the next call of pn_connection_driver_next(). NULL if there are no more events available now, reading/writing may produce more. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga38f56836858b2d4a04ab961f650950d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga38f56836858b2d4a04ab961f650950d4">◆ </a></span>pn_connection_driver_finished()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pn_connection_driver_finished </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return true if the the driver is closed for reading and writing and there are no more events. </p> |
| <p>Call <a class="el" href="group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96" title="Unbind, release and free the connection and transport.">pn_connection_driver_destroy()</a> to free all related memory. </p> |
| |
| </div> |
| </div> |
| <a id="ga373eb1f632468582d025f5d6acf9655e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga373eb1f632468582d025f5d6acf9655e">◆ </a></span>pn_connection_driver_errorf()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_connection_driver_errorf </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a> * </td> |
| <td class="paramname"><em>d</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>fmt</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>...</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set transport error. </p> |
| <p>The name and formatted description are set on the transport condition, and returned as a PN_TRANSPORT_ERROR event from <a class="el" href="group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5" title="Get the next event to handle.">pn_connection_driver_next_event()</a>.</p> |
| <p>You must call this <em>before</em> <a class="el" href="group__connection__driver.html#ga11b59aec2b54acdefd63dfbce8d09a3f" title="Close the read side.">pn_connection_driver_read_close()</a> or <a class="el" href="group__connection__driver.html#gafdca1cd72d6da760d3df7981085b36ce" title="Close the write side.">pn_connection_driver_write_close()</a> to ensure the error is processed. </p> |
| |
| </div> |
| </div> |
| <a id="gab9d4f3255c83d7792fc17e5a020ff1c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gab9d4f3255c83d7792fc17e5a020ff1c0">◆ </a></span>pn_connection_driver_ptr()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__connection__driver.html#structpn__connection__driver__t">pn_connection_driver_t</a>** pn_connection_driver_ptr </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> |
| <td class="paramname"><em>connection</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Associate a pn_connection_t with its <a class="el" href="group__connection__driver.html#structpn__connection__driver__t" title="The elements needed to drive AMQP IO and events.">pn_connection_driver_t</a>. </p> |
| <p><b>NOTE</b>: this is only for use by IO integration writers. If you are using the standard pn_proactor_t you <em>must not</em> use this function.</p> |
| <dl class="section return"><dt>Returns</dt><dd>pointer to the pn_connection_driver_t* field in a pn_connection_t.</dd></dl> |
| <p>Return type is pointer to a pointer so that the caller can (if desired) use atomic operations when loading and storing the value. </p> |
| |
| </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> |
