blob: 8247fe5e318cc12d9c76b2b9a99439268c4be3b6 [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: proton/raw_connection.h File Reference</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('raw__connection_8h.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">raw_connection.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="condition_8h_source.html">proton/condition.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="event_8h_source.html">proton/event.h</a>&gt;</code><br />
<code>#include &lt;proton/import_export.h&gt;</code><br />
<code>#include &lt;<a class="el" href="types_8h_source.html">proton/types.h</a>&gt;</code><br />
</div>
<p><a href="raw__connection_8h_source.html">Go to the source code of this file.</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__raw__buffer__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#structpn__raw__buffer__t">pn_raw_buffer_t</a></td></tr>
<tr class="memdesc:structpn__raw__buffer__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor used to represent a single raw buffer in memory. <a href="group__raw__connection.html#structpn__raw__buffer__t">More...</a><br /></td></tr>
<tr class="separator:structpn__raw__buffer__t"><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:gaae8e5b4a86a4f025ece3c3e424ac585d"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gaae8e5b4a86a4f025ece3c3e424ac585d">pn_raw_connection</a> (void)</td></tr>
<tr class="memdesc:gaae8e5b4a86a4f025ece3c3e424ac585d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new raw connection for use with the <a class="el" href="group__proactor.html">Proactor</a>. <a href="group__raw__connection.html#gaae8e5b4a86a4f025ece3c3e424ac585d">More...</a><br /></td></tr>
<tr class="separator:gaae8e5b4a86a4f025ece3c3e424ac585d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64743d369497e272f0d3617526e00373"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN const struct <a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga64743d369497e272f0d3617526e00373">pn_raw_connection_local_addr</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga64743d369497e272f0d3617526e00373"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the local address of a raw connection. <a href="group__raw__connection.html#ga64743d369497e272f0d3617526e00373">More...</a><br /></td></tr>
<tr class="separator:ga64743d369497e272f0d3617526e00373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31625ba605ca925685463b300d8c2dca"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN const struct <a class="el" href="group__proactor.html#ga79d820cd3ad391cc5207c83dbb373a9c">pn_netaddr_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga31625ba605ca925685463b300d8c2dca">pn_raw_connection_remote_addr</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga31625ba605ca925685463b300d8c2dca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the local address of a raw connection. <a href="group__raw__connection.html#ga31625ba605ca925685463b300d8c2dca">More...</a><br /></td></tr>
<tr class="separator:ga31625ba605ca925685463b300d8c2dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc38bdc0c5adbd5b7a41a188a895fb7f"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gadc38bdc0c5adbd5b7a41a188a895fb7f">pn_raw_connection_close</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gadc38bdc0c5adbd5b7a41a188a895fb7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close a raw connection. <a href="group__raw__connection.html#gadc38bdc0c5adbd5b7a41a188a895fb7f">More...</a><br /></td></tr>
<tr class="separator:gadc38bdc0c5adbd5b7a41a188a895fb7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28896d789da87c24614ea13276e0bbd0"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga28896d789da87c24614ea13276e0bbd0">pn_raw_connection_read_buffers_capacity</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga28896d789da87c24614ea13276e0bbd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the raw connection for how many more read buffers it can be given. <br /></td></tr>
<tr class="separator:ga28896d789da87c24614ea13276e0bbd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac759d82c72058e69301e8a10a3df0e57"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gac759d82c72058e69301e8a10a3df0e57">pn_raw_connection_write_buffers_capacity</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gac759d82c72058e69301e8a10a3df0e57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the raw connection for how many more write buffers it can be given. <br /></td></tr>
<tr class="separator:gac759d82c72058e69301e8a10a3df0e57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0d8c66c40f79650db663cee78713413"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gad0d8c66c40f79650db663cee78713413">pn_raw_connection_give_read_buffers</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection, <a class="el" href="group__raw__connection.html#structpn__raw__buffer__t">pn_raw_buffer_t</a> const *buffers, size_t num)</td></tr>
<tr class="memdesc:gad0d8c66c40f79650db663cee78713413"><td class="mdescLeft">&#160;</td><td class="mdescRight">Give the raw connection buffers to use for reading from the underlying socket. <a href="group__raw__connection.html#gad0d8c66c40f79650db663cee78713413">More...</a><br /></td></tr>
<tr class="separator:gad0d8c66c40f79650db663cee78713413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae98d3b7cf675b6f780d6539a18d24530"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gae98d3b7cf675b6f780d6539a18d24530">pn_raw_connection_take_read_buffers</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection, <a class="el" href="group__raw__connection.html#structpn__raw__buffer__t">pn_raw_buffer_t</a> *buffers, size_t num)</td></tr>
<tr class="memdesc:gae98d3b7cf675b6f780d6539a18d24530"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch buffers with bytes read from the raw socket. <a href="group__raw__connection.html#gae98d3b7cf675b6f780d6539a18d24530">More...</a><br /></td></tr>
<tr class="separator:gae98d3b7cf675b6f780d6539a18d24530"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3167efa9818f821a6af1565859b9e440"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga3167efa9818f821a6af1565859b9e440">pn_raw_connection_write_buffers</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection, <a class="el" href="group__raw__connection.html#structpn__raw__buffer__t">pn_raw_buffer_t</a> const *buffers, size_t num)</td></tr>
<tr class="memdesc:ga3167efa9818f821a6af1565859b9e440"><td class="mdescLeft">&#160;</td><td class="mdescRight">Give the raw connection buffers to write to the underlying socket. <a href="group__raw__connection.html#ga3167efa9818f821a6af1565859b9e440">More...</a><br /></td></tr>
<tr class="separator:ga3167efa9818f821a6af1565859b9e440"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4169b0f5c64fa2333f147f0eec271129"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga4169b0f5c64fa2333f147f0eec271129">pn_raw_connection_take_written_buffers</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection, <a class="el" href="group__raw__connection.html#structpn__raw__buffer__t">pn_raw_buffer_t</a> *buffers, size_t num)</td></tr>
<tr class="memdesc:ga4169b0f5c64fa2333f147f0eec271129"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a buffer chain with buffers that have all been written to the raw socket. <a href="group__raw__connection.html#ga4169b0f5c64fa2333f147f0eec271129">More...</a><br /></td></tr>
<tr class="separator:ga4169b0f5c64fa2333f147f0eec271129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed0d0d70ead71c5d2a64317edf1daca2"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gaed0d0d70ead71c5d2a64317edf1daca2">pn_raw_connection_is_read_closed</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gaed0d0d70ead71c5d2a64317edf1daca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is <code>connection</code> closed for read? <a href="group__raw__connection.html#gaed0d0d70ead71c5d2a64317edf1daca2">More...</a><br /></td></tr>
<tr class="separator:gaed0d0d70ead71c5d2a64317edf1daca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf15a987d6a4fc42fb665c6b482cf4442"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gaf15a987d6a4fc42fb665c6b482cf4442">pn_raw_connection_is_write_closed</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gaf15a987d6a4fc42fb665c6b482cf4442"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is <code>connection</code> closed for write? <a href="group__raw__connection.html#gaf15a987d6a4fc42fb665c6b482cf4442">More...</a><br /></td></tr>
<tr class="separator:gaf15a987d6a4fc42fb665c6b482cf4442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca978a14e487ec6a6410f031c2ac0432"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gaca978a14e487ec6a6410f031c2ac0432">pn_raw_connection_wake</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gaca978a14e487ec6a6410f031c2ac0432"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa471e4c60d57ab77eb9bc1716fa50134d">PN_RAW_CONNECTION_WAKE</a> event for <code>connection</code> as soon as possible. <a href="group__raw__connection.html#gaca978a14e487ec6a6410f031c2ac0432">More...</a><br /></td></tr>
<tr class="separator:gaca978a14e487ec6a6410f031c2ac0432"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d2e343f71310e1d1d76d677a4cc32cf"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga5d2e343f71310e1d1d76d677a4cc32cf">pn_raw_connection_condition</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga5d2e343f71310e1d1d76d677a4cc32cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get additional information about a raw connection error. <a href="group__raw__connection.html#ga5d2e343f71310e1d1d76d677a4cc32cf">More...</a><br /></td></tr>
<tr class="separator:ga5d2e343f71310e1d1d76d677a4cc32cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabaa162a817447cadfb08cb742c13baaf"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gabaa162a817447cadfb08cb742c13baaf">pn_raw_connection_get_context</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:gabaa162a817447cadfb08cb742c13baaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the application context associated with this raw connection. <a href="group__raw__connection.html#gabaa162a817447cadfb08cb742c13baaf">More...</a><br /></td></tr>
<tr class="separator:gabaa162a817447cadfb08cb742c13baaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe1796a50ddd8b0987686b556f477e81"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gafe1796a50ddd8b0987686b556f477e81">pn_raw_connection_set_context</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection, void *context)</td></tr>
<tr class="memdesc:gafe1796a50ddd8b0987686b556f477e81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new application context for a raw connection. <a href="group__raw__connection.html#gafe1796a50ddd8b0987686b556f477e81">More...</a><br /></td></tr>
<tr class="separator:gafe1796a50ddd8b0987686b556f477e81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b17a45f4b791b5bbfe32844cb22e5cb"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN pn_record_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#ga5b17a45f4b791b5bbfe32844cb22e5cb">pn_raw_connection_attachments</a> (<a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *connection)</td></tr>
<tr class="memdesc:ga5b17a45f4b791b5bbfe32844cb22e5cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the attachments that are associated with a raw connection. <br /></td></tr>
<tr class="separator:ga5b17a45f4b791b5bbfe32844cb22e5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf363bfb40f61c6c368fbf452f0bdd5c1"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__raw__connection.html#gaf363bfb40f61c6c368fbf452f0bdd5c1">pn_event_raw_connection</a> (<a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event)</td></tr>
<tr class="memdesc:gaf363bfb40f61c6c368fbf452f0bdd5c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the raw connection associated with an event. <a href="group__raw__connection.html#gaf363bfb40f61c6c368fbf452f0bdd5c1">More...</a><br /></td></tr>
<tr class="separator:gaf363bfb40f61c6c368fbf452f0bdd5c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="raw__connection_8h.html">raw_connection.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>