libqpid-proton2-dev-doc 0.7-2 / usr / share / proton-0.7 / docs / api-c / a00050.html

This file is indexed.

/usr/share/proton-0.7/docs/api-c/a00050.html is in libqpid-proton2-dev-doc 0.7-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8"/>
<title>proton: Receiver</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">proton
   &#160;<span id="projectnumber">0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               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.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Receiver<div class="ingroups"><a class="el" href="a00046.html">Engine</a> &raquo; <a class="el" href="a00048.html">Link</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf331f33acd1fddbb6f8e674a8a7c6aa2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#gaf331f33acd1fddbb6f8e674a8a7c6aa2">pn_link_flow</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *receiver, int credit)</td></tr>
<tr class="memdesc:gaf331f33acd1fddbb6f8e674a8a7c6aa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Grant credit for incoming deliveries on a receiver.  <a href="#gaf331f33acd1fddbb6f8e674a8a7c6aa2">More...</a><br /></td></tr>
<tr class="separator:gaf331f33acd1fddbb6f8e674a8a7c6aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f48aec7e3de526bbdea1c4e99708357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ga2f48aec7e3de526bbdea1c4e99708357">pn_link_drain</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *receiver, int credit)</td></tr>
<tr class="memdesc:ga2f48aec7e3de526bbdea1c4e99708357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Grant credit for incoming deliveries on a receiver, and set drain mode to true.  <a href="#ga2f48aec7e3de526bbdea1c4e99708357">More...</a><br /></td></tr>
<tr class="separator:ga2f48aec7e3de526bbdea1c4e99708357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22837f7f8e152add8de867bbe4163892"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ga22837f7f8e152add8de867bbe4163892">pn_link_set_drain</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *receiver, bool drain)</td></tr>
<tr class="memdesc:ga22837f7f8e152add8de867bbe4163892"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the drain mode on a link.  <a href="#ga22837f7f8e152add8de867bbe4163892">More...</a><br /></td></tr>
<tr class="separator:ga22837f7f8e152add8de867bbe4163892"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa98289676877e6c820a95e4bce94eda6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#gaa98289676877e6c820a95e4bce94eda6">pn_link_recv</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *receiver, char *bytes, size_t n)</td></tr>
<tr class="memdesc:gaa98289676877e6c820a95e4bce94eda6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive message data for the current delivery on a link.  <a href="#gaa98289676877e6c820a95e4bce94eda6">More...</a><br /></td></tr>
<tr class="separator:gaa98289676877e6c820a95e4bce94eda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacda3e0bc16ff65cbfa99087f9da025c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#gacda3e0bc16ff65cbfa99087f9da025c7">pn_link_draining</a> (<a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *receiver)</td></tr>
<tr class="memdesc:gacda3e0bc16ff65cbfa99087f9da025c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a link is currently draining.  <a href="#gacda3e0bc16ff65cbfa99087f9da025c7">More...</a><br /></td></tr>
<tr class="separator:gacda3e0bc16ff65cbfa99087f9da025c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga2f48aec7e3de526bbdea1c4e99708357"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_link_drain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *&#160;</td>
          <td class="paramname"><em>receiver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>credit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Grant credit for incoming deliveries on a receiver, and set drain mode to true. </p>
<p>Use <a class="el" href="a00050.html#ga22837f7f8e152add8de867bbe4163892" title="Set the drain mode on a link. ">pn_link_set_drain</a> to set the drain mode explicitly.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">receiver</td><td>a receiving link object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">credit</td><td>the amount to increment the link credit </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gacda3e0bc16ff65cbfa99087f9da025c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_link_draining </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *&#160;</td>
          <td class="paramname"><em>receiver</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check if a link is currently draining. </p>
<p>A link is defined to be draining when drain mode is set to true, and the sender still has excess credit.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">receiver</td><td>a receiving link object </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the link is currently draining, false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="gaf331f33acd1fddbb6f8e674a8a7c6aa2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_link_flow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *&#160;</td>
          <td class="paramname"><em>receiver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>credit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Grant credit for incoming deliveries on a receiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">receiver</td><td>a receiving link object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">credit</td><td>the amount to increment the link credit </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gaa98289676877e6c820a95e4bce94eda6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_link_recv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *&#160;</td>
          <td class="paramname"><em>receiver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>n</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive message data for the current delivery on a link. </p>
<p>Use <a class="el" href="a00044.html#ga6ad7ae3286b0a4f553b33ea9ce5bb172" title="Get the amount of pending message data for a delivery. ">pn_delivery_pending</a> on the current delivery to figure out how much buffer space is needed.</p>
<p>Note that the link API can be used to stream large messages across the network, so just because there is no data to read does not imply the message is complete. To ensure the entirety of the message data has been read, either invoke <a class="el" href="a00050.html#gaa98289676877e6c820a95e4bce94eda6" title="Receive message data for the current delivery on a link. ">pn_link_recv</a> until PN_EOS is returned, or verify that <a class="el" href="a00044.html#gad3cdc28f24b74b71e547881b16c6c20b" title="Check if a delivery only has partial message data. ">pn_delivery_partial</a> is false, and <a class="el" href="a00044.html#ga6ad7ae3286b0a4f553b33ea9ce5bb172" title="Get the amount of pending message data for a delivery. ">pn_delivery_pending</a> is 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">receiver</td><td>a receiving link object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bytes</td><td>a pointer to an empty buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>the buffer capacity </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes received, PN_EOS, or an error code </dd></dl>

</div>
</div>
<a class="anchor" id="ga22837f7f8e152add8de867bbe4163892"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_link_set_drain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00048.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> *&#160;</td>
          <td class="paramname"><em>receiver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>drain</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the drain mode on a link. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">receiver</td><td>a receiving link object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">drain</td><td>the drain mode </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 17 2014 10:28:04 for proton by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.