libqpid-proton2-dev-doc 0.10-2 / usr / share / proton-0.10 / docs / api-c / a00023.html

This file is indexed.

/usr/share/proton-0.10/docs/api-c/a00023.html is in libqpid-proton2-dev-doc 0.10-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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
<!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.11"/>
<title>proton: /build/qpid-proton-9HU5Bc/qpid-proton-0.10/proton-c/include/proton/io.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="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">
  $(document).ready(function() { init_search(); });
</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">proton
   &#160;<span id="projectnumber">0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_3d7fee5163f29235853f3037db69c226.html">proton-c</a></li><li class="navelem"><a class="el" href="dir_ca4610195e991eb8124aba7312da0967.html">include</a></li><li class="navelem"><a class="el" href="dir_819e9c3ec552076ba9984156db77a62b.html">proton</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<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">io.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="a00022_source.html">proton/import_export.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="a00019_source.html">proton/error.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="a00039_source.html">proton/type_compat.h</a>&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
</div>
<p><a href="a00023_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adcb31f47d850487e255a347ee9358f12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#adcb31f47d850487e255a347ee9358f12">PN_INVALID_SOCKET</a>&#160;&#160;&#160;(-1)</td></tr>
<tr class="separator:adcb31f47d850487e255a347ee9358f12"><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:ad9d8983f48e8a1ea1f029dd905dad3cd"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a></td></tr>
<tr class="memdesc:ad9d8983f48e8a1ea1f029dd905dad3cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd" title="A pn_socket_t provides an abstract handle to an IO stream. ">pn_socket_t</a> provides an abstract handle to an IO stream.  <a href="#ad9d8983f48e8a1ea1f029dd905dad3cd">More...</a><br /></td></tr>
<tr class="separator:ad9d8983f48e8a1ea1f029dd905dad3cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3809af513a2e401402161435f59108ef"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a></td></tr>
<tr class="memdesc:a3809af513a2e401402161435f59108ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef" title="A pn_io_t manages IO for a group of pn_socket_t handles. ">pn_io_t</a> manages IO for a group of pn_socket_t handles.  <a href="#a3809af513a2e401402161435f59108ef">More...</a><br /></td></tr>
<tr class="separator:a3809af513a2e401402161435f59108ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c6d837ad72ee553fbeeb47a5d08f6fa"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a></td></tr>
<tr class="memdesc:a4c6d837ad72ee553fbeeb47a5d08f6fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa" title="A pn_selector_t provides a selection mechanism that allows efficient monitoring of a large number of ...">pn_selector_t</a> provides a selection mechanism that allows efficient monitoring of a large number of Proton connections and listeners.  <a href="#a4c6d837ad72ee553fbeeb47a5d08f6fa">More...</a><br /></td></tr>
<tr class="separator:a4c6d837ad72ee553fbeeb47a5d08f6fa"><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:ac2665c36ef0f8a10703ca364794354a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ac2665c36ef0f8a10703ca364794354a6">pn_io</a> (void)</td></tr>
<tr class="separator:ac2665c36ef0f8a10703ca364794354a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae87974c84ad769a2a155953fb801ef0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ae87974c84ad769a2a155953fb801ef0d">pn_io_free</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io)</td></tr>
<tr class="separator:ae87974c84ad769a2a155953fb801ef0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a526ac9983cb55a64471b2f1659e91e5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00019.html#a24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a526ac9983cb55a64471b2f1659e91e5f">pn_io_error</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io)</td></tr>
<tr class="separator:a526ac9983cb55a64471b2f1659e91e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b76de4be43b7565baa1669eb05ae2ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a0b76de4be43b7565baa1669eb05ae2ce">pn_connect</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, const char *host, const char *port)</td></tr>
<tr class="separator:a0b76de4be43b7565baa1669eb05ae2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18e2f765ab1e84930c558dc3fc50f18a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a18e2f765ab1e84930c558dc3fc50f18a">pn_listen</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, const char *host, const char *port)</td></tr>
<tr class="separator:a18e2f765ab1e84930c558dc3fc50f18a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38abf7e52c55546980fceb6a42811b96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a38abf7e52c55546980fceb6a42811b96">pn_accept</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket, char *name, size_t size)</td></tr>
<tr class="separator:a38abf7e52c55546980fceb6a42811b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71b293e8e139ec2a5e249263a261e286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a71b293e8e139ec2a5e249263a261e286">pn_close</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket)</td></tr>
<tr class="separator:a71b293e8e139ec2a5e249263a261e286"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a935313742aaa169ffec171d50b3d6d17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a935313742aaa169ffec171d50b3d6d17">pn_send</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket, const void *buf, size_t size)</td></tr>
<tr class="separator:a935313742aaa169ffec171d50b3d6d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26cc5640e5e53a274a1824aadbabf333"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a26cc5640e5e53a274a1824aadbabf333">pn_recv</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket, void *buf, size_t size)</td></tr>
<tr class="separator:a26cc5640e5e53a274a1824aadbabf333"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9962c4768bc90e9ee6b58eea6416cd20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a9962c4768bc90e9ee6b58eea6416cd20">pn_pipe</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> *dest)</td></tr>
<tr class="separator:a9962c4768bc90e9ee6b58eea6416cd20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4069102dba52a79223cdc226db99f2f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a4069102dba52a79223cdc226db99f2f2">pn_read</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket, void *buf, size_t size)</td></tr>
<tr class="separator:a4069102dba52a79223cdc226db99f2f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1790c7cdca0900eecb8c302a0ba58a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#aa1790c7cdca0900eecb8c302a0ba58a5">pn_write</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io, <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> socket, const void *buf, size_t size)</td></tr>
<tr class="separator:aa1790c7cdca0900eecb8c302a0ba58a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad68685dfc871537856d1f087a032530c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#ad68685dfc871537856d1f087a032530c">pn_wouldblock</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io)</td></tr>
<tr class="separator:ad68685dfc871537856d1f087a032530c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6ada8034a0985c90d962a8ad88d7746"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#aa6ada8034a0985c90d962a8ad88d7746">pn_io_selector</a> (<a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *io)</td></tr>
<tr class="separator:aa6ada8034a0985c90d962a8ad88d7746"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="adcb31f47d850487e255a347ee9358f12"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PN_INVALID_SOCKET&#160;&#160;&#160;(-1)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a3809af513a2e401402161435f59108ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef" title="A pn_io_t manages IO for a group of pn_socket_t handles. ">pn_io_t</a> manages IO for a group of pn_socket_t handles. </p>
<p>A pn_io_t object may have zero or one pn_selector_t selectors associated with it (see <a class="el" href="a00023.html#aa6ada8034a0985c90d962a8ad88d7746">pn_io_selector()</a>). If one is associated, all the pn_socket_t handles managed by a pn_io_t must use that pn_selector_t instance.</p>
<p>The pn_io_t interface is single-threaded. All methods are intended to be used by one thread at a time, except that multiple threads may use:</p>
<p><a class="el" href="a00023.html#aa1790c7cdca0900eecb8c302a0ba58a5">pn_write()</a> <a class="el" href="a00023.html#a935313742aaa169ffec171d50b3d6d17">pn_send()</a> <a class="el" href="a00023.html#a26cc5640e5e53a274a1824aadbabf333">pn_recv()</a> <a class="el" href="a00023.html#a71b293e8e139ec2a5e249263a261e286">pn_close()</a> <a class="el" href="a00034.html#a7bb5470e033b71512845662f5f1ab236">pn_selector_select()</a></p>
<p>provided at most one thread is calling <a class="el" href="a00034.html#a7bb5470e033b71512845662f5f1ab236">pn_selector_select()</a> and the other threads are operating on separate pn_socket_t handles. </p>

</div>
</div>
<a class="anchor" id="a4c6d837ad72ee553fbeeb47a5d08f6fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a> <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa" title="A pn_selector_t provides a selection mechanism that allows efficient monitoring of a large number of ...">pn_selector_t</a> provides a selection mechanism that allows efficient monitoring of a large number of Proton connections and listeners. </p>
<p>External (non-Proton) sockets may also be monitored, either solely for event notification (read, write, and timer) or event notification and use with pn_io_t interfaces. </p>

</div>
</div>
<a class="anchor" id="ad9d8983f48e8a1ea1f029dd905dad3cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd" title="A pn_socket_t provides an abstract handle to an IO stream. ">pn_socket_t</a> provides an abstract handle to an IO stream. </p>
<p>The pipe version is uni-directional. The network socket version is bi-directional. Both are non-blocking.</p>
<p>pn_socket_t handles from <a class="el" href="a00023.html#a9962c4768bc90e9ee6b58eea6416cd20">pn_pipe()</a> may only be used with <a class="el" href="a00023.html#a4069102dba52a79223cdc226db99f2f2">pn_read()</a>, <a class="el" href="a00023.html#aa1790c7cdca0900eecb8c302a0ba58a5">pn_write()</a>, <a class="el" href="a00023.html#a71b293e8e139ec2a5e249263a261e286">pn_close()</a> and <a class="el" href="a00034.html#a7bb5470e033b71512845662f5f1ab236">pn_selector_select()</a>.</p>
<p>pn_socket_t handles from <a class="el" href="a00023.html#a18e2f765ab1e84930c558dc3fc50f18a">pn_listen()</a>, <a class="el" href="a00023.html#a38abf7e52c55546980fceb6a42811b96">pn_accept()</a> and <a class="el" href="a00023.html#a0b76de4be43b7565baa1669eb05ae2ce">pn_connect()</a> must perform further IO using Proton functions. Mixing Proton <a class="el" href="a00023.html">io.h</a> functions with native IO functions on the same handles will result in undefined behavior.</p>
<p>pn_socket_t handles may only be used with a single pn_io_t during their lifetime. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a38abf7e52c55546980fceb6a42811b96"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> pn_accept </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a71b293e8e139ec2a5e249263a261e286"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_close </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a0b76de4be43b7565baa1669eb05ae2ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> pn_connect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>port</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ac2665c36ef0f8a10703ca364794354a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a>* pn_io </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a526ac9983cb55a64471b2f1659e91e5f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00019.html#a24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>* pn_io_error </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ae87974c84ad769a2a155953fb801ef0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_io_free </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa6ada8034a0985c90d962a8ad88d7746"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#a4c6d837ad72ee553fbeeb47a5d08f6fa">pn_selector_t</a>* pn_io_selector </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a18e2f765ab1e84930c558dc3fc50f18a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> pn_listen </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>port</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a9962c4768bc90e9ee6b58eea6416cd20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_pipe </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a> *&#160;</td>
          <td class="paramname"><em>dest</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a4069102dba52a79223cdc226db99f2f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a26cc5640e5e53a274a1824aadbabf333"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_recv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a935313742aaa169ffec171d50b3d6d17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ad68685dfc871537856d1f087a032530c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_wouldblock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa1790c7cdca0900eecb8c302a0ba58a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_write </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00023.html#a3809af513a2e401402161435f59108ef">pn_io_t</a> *&#160;</td>
          <td class="paramname"><em>io</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00023.html#ad9d8983f48e8a1ea1f029dd905dad3cd">pn_socket_t</a>&#160;</td>
          <td class="paramname"><em>socket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 4 2016 09:18:57 for proton by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.