/usr/share/proton-0.14.0/docs/api-c/connection__engine_8h_source.html is in libqpid-proton8-dev-doc 0.14.0-5.1ubuntu1.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>proton: /build/qpid-proton-4llz2H/qpid-proton-0.14.0/proton-c/include/proton/connection_engine.h Source File</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>
<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
 <span id="projectnumber">0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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="headertitle">
<div class="title">connection_engine.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="connection__engine_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_CONNECTION_ENGINE_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_CONNECTION_ENGINE_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">///@file</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">///</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// **Experimental** The Connection Engine API wraps up the proton engine</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// objects associated with a single connection: pn_connection_t, pn_transport_t</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/// and pn_collector_t. It provides a simple bytes-in/bytes-out interface for IO</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/// and generates pn_event_t events to be handled by the application.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">///</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// The connection engine can be fed with raw AMQP bytes from any source, and it</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/// generates AMQP byte output to be written to any destination. You can use the</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// engine to integrate proton AMQP with any IO library, or native IO on any</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// platform.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">///</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/// The engine is not thread safe but each engine is independent. Separate</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// engines can be used concurrently. For example a multi-threaded application</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/// can process connections in multiple threads, but serialize work for each</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/// connection to the corresponding engine.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">///</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/// The engine is designed to be thread and IO neutral so it can be integrated with</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/// single or multi-threaded code in reactive or proactive IO frameworks.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">///</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// Summary of use:</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">///</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/// - while !pn_connection_engine_finished()</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// - Read data from your source into pn_connection_engine_read_buffer()</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/// - Call pn_connection_engine_read_done() when complete.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// - Write data from pn_connection_engine_write_buffer() to your destination.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/// - Call pn_connection_engine_write_done() to indicate how much was written.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/// - Call pn_connection_engine_dispatch() to dispatch events until it returns NULL.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">///</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/// Note on error handling: most of the pn_connection_engine_*() functions do</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/// not return an error code. If a fatal error occurs, the transport error</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/// condition will be set and the next call to pn_connection_engine_dispatch()</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/// report it to the handler as a PN_TRANSPORT_ERROR event and return false.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">///</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/// @defgroup connection_engine The Connection Engine</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/// @ingroup connection_engine</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/// @{</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">///</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#include <<a class="code" href="condition_8h.html">proton/condition.h</a>></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#include <<a class="code" href="event_8h.html">proton/event.h</a>></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#include <<a class="code" href="import__export_8h.html">proton/import_export.h</a>></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/// A modifiable memory buffer.</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structpn__buf__t.html"> 72</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpn__buf__t.html">pn_buf_t</a> {</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structpn__buf__t.html#a4fcd7ee2115ec091278735689739314d"> 73</a></span>  <span class="keywordtype">char</span>* <a class="code" href="structpn__buf__t.html#a4fcd7ee2115ec091278735689739314d">data</a>; <span class="comment">///< Beginning of the buffered data.</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structpn__buf__t.html#aa468d331f86b5d2c9592b98169bc375d"> 74</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structpn__buf__t.html#aa468d331f86b5d2c9592b98169bc375d">size</a>; <span class="comment">///< Number of bytes in the buffer.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span>} <a class="code" href="group__connection__engine.html#gaa6d94f34ba3e14a5e7176def257a6dc5">pn_buf_t</a>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/// Create a pn_buf</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="structpn__buf__t.html">pn_buf_t</a> <a class="code" href="group__connection__engine.html#ga644509ac6d43dbc093ad55a0b1b09618">pn_buf</a>(<span class="keywordtype">char</span>* <a class="code" href="structpn__buf__t.html#a4fcd7ee2115ec091278735689739314d">data</a>, <span class="keywordtype">size_t</span> <a class="code" href="structpn__buf__t.html#aa468d331f86b5d2c9592b98169bc375d">size</a>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/// A read-only memory buffer.</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structpn__cbuf__t.html"> 81</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpn__cbuf__t.html">pn_cbuf_t</a> {</div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structpn__cbuf__t.html#aa6b3f44b7cf0eed9dc9f4a6cb51d56d8"> 82</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structpn__cbuf__t.html#aa6b3f44b7cf0eed9dc9f4a6cb51d56d8">data</a>; <span class="comment">///< Beginning of the buffered data.</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structpn__cbuf__t.html#af63695131f87cda173237c5d68e2633b"> 83</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structpn__cbuf__t.html#af63695131f87cda173237c5d68e2633b">size</a>; <span class="comment">///< Number of bytes in the buffer.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span>} <a class="code" href="group__connection__engine.html#ga145c4981ce9d390ed9aaa3e0bf471fd3">pn_cbuf_t</a>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// Create a pn_cbuf</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="structpn__cbuf__t.html">pn_cbuf_t</a> <a class="code" href="group__connection__engine.html#gad878a83fc95c96609243440f9f6ff15b">pn_cbuf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structpn__buf__t.html#a4fcd7ee2115ec091278735689739314d">data</a>, <span class="keywordtype">size_t</span> <a class="code" href="structpn__buf__t.html#aa468d331f86b5d2c9592b98169bc375d">size</a>);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/// A connection engine is a trio of pn_connection_t, pn_transport_t and pn_collector_t.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/// Use the pn_connection_engine_*() functions to operate on it.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/// It is a plain struct, not a proton object. Use pn_connection_engine_init to set up</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/// the initial objects and pn_connection_engine_final to release them.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">///</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="structpn__connection__engine__t.html"> 94</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a> {</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structpn__connection__engine__t.html#a711d5119f9e3e896afad907cb32bee60"> 95</a></span>  <a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>* <a class="code" href="structpn__connection__engine__t.html#a711d5119f9e3e896afad907cb32bee60">connection</a>;</div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="structpn__connection__engine__t.html#a42051c640bfd941d5b68cb3a8a70711b"> 96</a></span>  <a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a>* <a class="code" href="structpn__connection__engine__t.html#a42051c640bfd941d5b68cb3a8a70711b">transport</a>;</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="structpn__connection__engine__t.html#aa8b404ea362613a1efe37d6ccd3b20f9"> 97</a></span>  <a class="code" href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a>* <a class="code" href="structpn__connection__engine__t.html#aa8b404ea362613a1efe37d6ccd3b20f9">collector</a>;</div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="structpn__connection__engine__t.html#ad8be1ce72f03c6330a2302bbed8196b9"> 98</a></span>  <a class="code" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a>* <a class="code" href="structpn__connection__engine__t.html#ad8be1ce72f03c6330a2302bbed8196b9">event</a>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> } <a class="code" href="group__connection__engine.html#gaa72fd40bd99d6702cedd5f33d325e945">pn_connection_engine_t</a>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/// Initialize a pn_connection_engine_t struct with a new connection, transport</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/// and collector. Return 0 on success, a proton error code on failure.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">int</span> <a class="code" href="group__connection__engine.html#gaf63012d048980969964b277d2a11fa59">pn_connection_engine_init</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>* engine);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/// Release the connection, transport and collector associated with engine, set all the pointers</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/// to NULL. Only call on an engine that was initialized with pn_connection_engine_init</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#ga0bfd3ac3afbcb665cb53116747e30b6b">pn_connection_engine_final</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>* engine);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/// The engine's read buffer. Read data from your IO source into buf.data, up to</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">/// a max of buf.size. Then call pn_connection_engine_read_done().</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">///</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/// buf.size==0 means the engine cannot read presently, calling</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">/// pn_connection_engine_dispatch() may create more buffer space.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">///</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="structpn__buf__t.html">pn_buf_t</a> <a class="code" href="group__connection__engine.html#gad7be7c47d7ced284a7a063740c3190ab">pn_connection_engine_read_buffer</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">/// Consume the first n bytes of data in pn_connection_engine_read_buffer() and</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/// update the buffer.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#ga709193ccc0ef9b69d9258187848ee5b2">pn_connection_engine_read_done</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">/// Close the read side of the transport when no more data is available.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">/// Note there may still be events for pn_connection_engine_dispatch() or data</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/// in pn_connection_engine_write_buffer()</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#gaace5db39fa0ff863537f4a1b28f26bfa">pn_connection_engine_read_close</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"></span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">/// The engine's write buffer. Write data from buf.data to your IO destination,</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">/// up to a max of buf.size. Then call pn_connection_engine_write_done().</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">///</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/// buf.size==0 means the engine has nothing to write presently. Calling</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/// pn_connection_engine_dispatch() may generate more data.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="structpn__cbuf__t.html">pn_cbuf_t</a> <a class="code" href="group__connection__engine.html#ga23d45a51492505e1c5bdab0772229f87">pn_connection_engine_write_buffer</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/// Call when the first n bytes of pn_connection_engine_write_buffer() have been</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">/// written to IO and can be re-used for new data. Updates the buffer.</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#gafb4a17a83b65e129e6045fe09a80a328">pn_connection_engine_write_done</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">/// Call when the write side of IO has closed and no more data can be written.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/// Note that there may still be events for pn_connection_engine_dispatch() or</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/// data to read into pn_connection_engine_read_buffer().</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#ga0fec7f4c27337722b67a8ebe5d5e3857">pn_connection_engine_write_close</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/// Close both sides of the transport, equivalent to</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">/// pn_connection_engine_read_close(); pn_connection_engine_write_close()</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">///</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/// You must still call pn_connection_engine_dispatch() to process final</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/// events.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">///</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/// To provide transport error information to the handler, set it on</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/// pn_connection_engine_condition()</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/// *before* calling pn_connection_engine_disconnected(). This sets</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">/// the error on the pn_transport_t object.</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">///</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/// Note this does *not* modify the pn_connection_t, so you can distinguish</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/// between a connection close error sent by the remote peer (which will set the</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/// connection condition) and a transport error (which sets the transport</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/// condition.)</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">///</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__connection__engine.html#ga0523c0805aa37468414f22421f849f50">pn_connection_engine_disconnected</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">/// Get the next available event.</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/// Call in a loop until it returns NULL to dispatch all available events.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/// Note this call may modify the read and write buffers.</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">///</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">/// @return Pointer to the next event, or NULL if there are none available.</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">///</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a>* <a class="code" href="group__connection__engine.html#gaf8274e2ece108708422d10e19565765a">pn_connection_engine_dispatch</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/// Return true if the engine is finished - all data has been written, all</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/// events have been handled and the transport is closed.</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">bool</span> <a class="code" href="group__connection__engine.html#ga71879bf76e1cce4121d8ecd56d28ea06">pn_connection_engine_finished</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/// Get the AMQP connection, owned by the pn_connection_engine_t.</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a>* <a class="code" href="group__connection__engine.html#ga63f5022e371f90971e8b5c4c46a4c9ea">pn_connection_engine_connection</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"></span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">/// Get the proton transport, owned by the pn_connection_engine_t.</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a>* <a class="code" href="group__connection__engine.html#ga646b6151d3dc729300285868fabad11d">pn_connection_engine_transport</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"></span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">/// Get the condition object for the engine's transport.</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">///</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">/// Note that IO errors should be set on this, the transport condition, not on</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">/// the pn_connection_t condition. The connection's condition is for errors</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/// received via the AMQP protocol, the transport condition is for errors in the</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">/// the IO layer such as a socket read or disconnect errors.</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">///</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"></span><a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>* <a class="code" href="group__connection__engine.html#gab6b02e7480270a9ff64e71b391a6cd0f">pn_connection_engine_condition</a>(<a class="code" href="structpn__connection__engine__t.html">pn_connection_engine_t</a>*);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"></span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">///@}</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"></span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> }</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor">#endif // PROTON_CONNECTION_ENGINE_H</span></div><div class="ttc" id="group__connection__engine_html_ga23d45a51492505e1c5bdab0772229f87"><div class="ttname"><a href="group__connection__engine.html#ga23d45a51492505e1c5bdab0772229f87">pn_connection_engine_write_buffer</a></div><div class="ttdeci">PN_EXTERN pn_cbuf_t pn_connection_engine_write_buffer(pn_connection_engine_t *)</div><div class="ttdoc">The engine&#39;s write buffer. </div></div>
<div class="ttc" id="structpn__connection__engine__t_html_ad8be1ce72f03c6330a2302bbed8196b9"><div class="ttname"><a href="structpn__connection__engine__t.html#ad8be1ce72f03c6330a2302bbed8196b9">pn_connection_engine_t::event</a></div><div class="ttdeci">pn_event_t * event</div><div class="ttdef"><b>Definition:</b> connection_engine.h:98</div></div>
<div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div></div>
<div class="ttc" id="import__export_8h_html"><div class="ttname"><a href="import__export_8h.html">import_export.h</a></div></div>
<div class="ttc" id="group__connection__engine_html_ga63f5022e371f90971e8b5c4c46a4c9ea"><div class="ttname"><a href="group__connection__engine.html#ga63f5022e371f90971e8b5c4c46a4c9ea">pn_connection_engine_connection</a></div><div class="ttdeci">PN_EXTERN pn_connection_t * pn_connection_engine_connection(pn_connection_engine_t *)</div><div class="ttdoc">Get the AMQP connection, owned by the pn_connection_engine_t. </div></div>
<div class="ttc" id="group__connection__engine_html_ga145c4981ce9d390ed9aaa3e0bf471fd3"><div class="ttname"><a href="group__connection__engine.html#ga145c4981ce9d390ed9aaa3e0bf471fd3">pn_cbuf_t</a></div><div class="ttdeci">struct pn_cbuf_t pn_cbuf_t</div><div class="ttdoc">A read-only memory buffer. </div></div>
<div class="ttc" id="group__connection__engine_html_gab6b02e7480270a9ff64e71b391a6cd0f"><div class="ttname"><a href="group__connection__engine.html#gab6b02e7480270a9ff64e71b391a6cd0f">pn_connection_engine_condition</a></div><div class="ttdeci">PN_EXTERN pn_condition_t * pn_connection_engine_condition(pn_connection_engine_t *)</div><div class="ttdoc">Get the condition object for the engine&#39;s transport. </div></div>
<div class="ttc" id="group__transport_html_gac26eda05f649bbf0399f3d8d78d12fa8"><div class="ttname"><a href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></div><div class="ttdeci">struct pn_transport_t pn_transport_t</div><div class="ttdoc">An AMQP Transport object. </div><div class="ttdef"><b>Definition:</b> types.h:262</div></div>
<div class="ttc" id="group__connection__engine_html_ga0523c0805aa37468414f22421f849f50"><div class="ttname"><a href="group__connection__engine.html#ga0523c0805aa37468414f22421f849f50">pn_connection_engine_disconnected</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_disconnected(pn_connection_engine_t *)</div><div class="ttdoc">Close both sides of the transport, equivalent to pn_connection_engine_read_close(); pn_connection_eng...</div></div>
<div class="ttc" id="group__connection__engine_html_gad7be7c47d7ced284a7a063740c3190ab"><div class="ttname"><a href="group__connection__engine.html#gad7be7c47d7ced284a7a063740c3190ab">pn_connection_engine_read_buffer</a></div><div class="ttdeci">PN_EXTERN pn_buf_t pn_connection_engine_read_buffer(pn_connection_engine_t *)</div><div class="ttdoc">The engine&#39;s read buffer. </div></div>
<div class="ttc" id="group__connection__engine_html_gaa72fd40bd99d6702cedd5f33d325e945"><div class="ttname"><a href="group__connection__engine.html#gaa72fd40bd99d6702cedd5f33d325e945">pn_connection_engine_t</a></div><div class="ttdeci">struct pn_connection_engine_t pn_connection_engine_t</div><div class="ttdoc">A connection engine is a trio of pn_connection_t, pn_transport_t and pn_collector_t. </div></div>
<div class="ttc" id="group__connection__engine_html_gaace5db39fa0ff863537f4a1b28f26bfa"><div class="ttname"><a href="group__connection__engine.html#gaace5db39fa0ff863537f4a1b28f26bfa">pn_connection_engine_read_close</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_read_close(pn_connection_engine_t *)</div><div class="ttdoc">Close the read side of the transport when no more data is available. </div></div>
<div class="ttc" id="group__connection__engine_html_ga709193ccc0ef9b69d9258187848ee5b2"><div class="ttname"><a href="group__connection__engine.html#ga709193ccc0ef9b69d9258187848ee5b2">pn_connection_engine_read_done</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_read_done(pn_connection_engine_t *, size_t n)</div><div class="ttdoc">Consume the first n bytes of data in pn_connection_engine_read_buffer() and update the buffer...</div></div>
<div class="ttc" id="group__connection__engine_html_ga644509ac6d43dbc093ad55a0b1b09618"><div class="ttname"><a href="group__connection__engine.html#ga644509ac6d43dbc093ad55a0b1b09618">pn_buf</a></div><div class="ttdeci">PN_EXTERN pn_buf_t pn_buf(char *data, size_t size)</div><div class="ttdoc">Create a pn_buf. </div></div>
<div class="ttc" id="import__export_8h_html_acfa9628d87130a64f95ee17c57a7c13b"><div class="ttname"><a href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a></div><div class="ttdeci">#define PN_EXTERN</div><div class="ttdef"><b>Definition:</b> import_export.h:53</div></div>
<div class="ttc" id="group__event_html_ga905cdecedb8020bc28e648e43348b5d1"><div class="ttname"><a href="group__event.html#ga905cdecedb8020bc28e648e43348b5d1">pn_collector_t</a></div><div class="ttdeci">struct pn_collector_t pn_collector_t</div><div class="ttdoc">An event collector. </div><div class="ttdef"><b>Definition:</b> types.h:250</div></div>
<div class="ttc" id="group__connection__engine_html_gaa6d94f34ba3e14a5e7176def257a6dc5"><div class="ttname"><a href="group__connection__engine.html#gaa6d94f34ba3e14a5e7176def257a6dc5">pn_buf_t</a></div><div class="ttdeci">struct pn_buf_t pn_buf_t</div><div class="ttdoc">A modifiable memory buffer. </div></div>
<div class="ttc" id="condition_8h_html"><div class="ttname"><a href="condition_8h.html">condition.h</a></div><div class="ttdoc">The Condition API for the proton Engine. </div></div>
<div class="ttc" id="structpn__buf__t_html_a4fcd7ee2115ec091278735689739314d"><div class="ttname"><a href="structpn__buf__t.html#a4fcd7ee2115ec091278735689739314d">pn_buf_t::data</a></div><div class="ttdeci">char * data</div><div class="ttdoc">Beginning of the buffered data. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:73</div></div>
<div class="ttc" id="group__connection__engine_html_ga646b6151d3dc729300285868fabad11d"><div class="ttname"><a href="group__connection__engine.html#ga646b6151d3dc729300285868fabad11d">pn_connection_engine_transport</a></div><div class="ttdeci">PN_EXTERN pn_transport_t * pn_connection_engine_transport(pn_connection_engine_t *)</div><div class="ttdoc">Get the proton transport, owned by the pn_connection_engine_t. </div></div>
<div class="ttc" id="group__connection__engine_html_gafb4a17a83b65e129e6045fe09a80a328"><div class="ttname"><a href="group__connection__engine.html#gafb4a17a83b65e129e6045fe09a80a328">pn_connection_engine_write_done</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_write_done(pn_connection_engine_t *, size_t n)</div><div class="ttdoc">Call when the first n bytes of pn_connection_engine_write_buffer() have been written to IO and can be...</div></div>
<div class="ttc" id="structpn__cbuf__t_html_af63695131f87cda173237c5d68e2633b"><div class="ttname"><a href="structpn__cbuf__t.html#af63695131f87cda173237c5d68e2633b">pn_cbuf_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Number of bytes in the buffer. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:83</div></div>
<div class="ttc" id="group__connection__engine_html_ga0fec7f4c27337722b67a8ebe5d5e3857"><div class="ttname"><a href="group__connection__engine.html#ga0fec7f4c27337722b67a8ebe5d5e3857">pn_connection_engine_write_close</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_write_close(pn_connection_engine_t *)</div><div class="ttdoc">Call when the write side of IO has closed and no more data can be written. </div></div>
<div class="ttc" id="group__connection__engine_html_ga71879bf76e1cce4121d8ecd56d28ea06"><div class="ttname"><a href="group__connection__engine.html#ga71879bf76e1cce4121d8ecd56d28ea06">pn_connection_engine_finished</a></div><div class="ttdeci">PN_EXTERN bool pn_connection_engine_finished(pn_connection_engine_t *)</div><div class="ttdoc">Return true if the engine is finished - all data has been written, all events have been handled and t...</div></div>
<div class="ttc" id="structpn__buf__t_html"><div class="ttname"><a href="structpn__buf__t.html">pn_buf_t</a></div><div class="ttdoc">A modifiable memory buffer. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:72</div></div>
<div class="ttc" id="structpn__connection__engine__t_html_a711d5119f9e3e896afad907cb32bee60"><div class="ttname"><a href="structpn__connection__engine__t.html#a711d5119f9e3e896afad907cb32bee60">pn_connection_engine_t::connection</a></div><div class="ttdeci">pn_connection_t * connection</div><div class="ttdef"><b>Definition:</b> connection_engine.h:95</div></div>
<div class="ttc" id="group__connection__engine_html_gaf8274e2ece108708422d10e19565765a"><div class="ttname"><a href="group__connection__engine.html#gaf8274e2ece108708422d10e19565765a">pn_connection_engine_dispatch</a></div><div class="ttdeci">PN_EXTERN pn_event_t * pn_connection_engine_dispatch(pn_connection_engine_t *)</div><div class="ttdoc">Get the next available event. </div></div>
<div class="ttc" id="structpn__connection__engine__t_html"><div class="ttname"><a href="structpn__connection__engine__t.html">pn_connection_engine_t</a></div><div class="ttdoc">A connection engine is a trio of pn_connection_t, pn_transport_t and pn_collector_t. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:94</div></div>
<div class="ttc" id="structpn__connection__engine__t_html_aa8b404ea362613a1efe37d6ccd3b20f9"><div class="ttname"><a href="structpn__connection__engine__t.html#aa8b404ea362613a1efe37d6ccd3b20f9">pn_connection_engine_t::collector</a></div><div class="ttdeci">pn_collector_t * collector</div><div class="ttdef"><b>Definition:</b> connection_engine.h:97</div></div>
<div class="ttc" id="event_8h_html"><div class="ttname"><a href="event_8h.html">event.h</a></div><div class="ttdoc">Event API for the proton Engine. </div></div>
<div class="ttc" id="group__connection__engine_html_gaf63012d048980969964b277d2a11fa59"><div class="ttname"><a href="group__connection__engine.html#gaf63012d048980969964b277d2a11fa59">pn_connection_engine_init</a></div><div class="ttdeci">PN_EXTERN int pn_connection_engine_init(pn_connection_engine_t *engine)</div><div class="ttdoc">Initialize a pn_connection_engine_t struct with a new connection, transport and collector. </div></div>
<div class="ttc" id="group__connection_html_ga886351d81ff3a977a284a206526c5aff"><div class="ttname"><a href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a></div><div class="ttdeci">struct pn_connection_t pn_connection_t</div><div class="ttdoc">An AMQP Connection object. </div><div class="ttdef"><b>Definition:</b> types.h:118</div></div>
<div class="ttc" id="group__condition_html_ga11eb7db7d2c205169fe3d47c996a95a5"><div class="ttname"><a href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></div><div class="ttdeci">struct pn_condition_t pn_condition_t</div><div class="ttdoc">An AMQP Condition object. </div><div class="ttdef"><b>Definition:</b> condition.h:64</div></div>
<div class="ttc" id="group__connection__engine_html_gad878a83fc95c96609243440f9f6ff15b"><div class="ttname"><a href="group__connection__engine.html#gad878a83fc95c96609243440f9f6ff15b">pn_cbuf</a></div><div class="ttdeci">PN_EXTERN pn_cbuf_t pn_cbuf(const char *data, size_t size)</div><div class="ttdoc">Create a pn_cbuf. </div></div>
<div class="ttc" id="structpn__connection__engine__t_html_a42051c640bfd941d5b68cb3a8a70711b"><div class="ttname"><a href="structpn__connection__engine__t.html#a42051c640bfd941d5b68cb3a8a70711b">pn_connection_engine_t::transport</a></div><div class="ttdeci">pn_transport_t * transport</div><div class="ttdef"><b>Definition:</b> connection_engine.h:96</div></div>
<div class="ttc" id="group__connection__engine_html_ga0bfd3ac3afbcb665cb53116747e30b6b"><div class="ttname"><a href="group__connection__engine.html#ga0bfd3ac3afbcb665cb53116747e30b6b">pn_connection_engine_final</a></div><div class="ttdeci">PN_EXTERN void pn_connection_engine_final(pn_connection_engine_t *engine)</div><div class="ttdoc">Release the connection, transport and collector associated with engine, set all the pointers to NULL...</div></div>
<div class="ttc" id="structpn__buf__t_html_aa468d331f86b5d2c9592b98169bc375d"><div class="ttname"><a href="structpn__buf__t.html#aa468d331f86b5d2c9592b98169bc375d">pn_buf_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Number of bytes in the buffer. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:74</div></div>
<div class="ttc" id="group__event_html_ga87f3028b4888632bbd56fb71ac737ae8"><div class="ttname"><a href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a></div><div class="ttdeci">struct pn_event_t pn_event_t</div><div class="ttdoc">An event provides notification of a state change within the protocol engine&#39;s object model...</div><div class="ttdef"><b>Definition:</b> event.h:77</div></div>
<div class="ttc" id="structpn__cbuf__t_html"><div class="ttname"><a href="structpn__cbuf__t.html">pn_cbuf_t</a></div><div class="ttdoc">A read-only memory buffer. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:81</div></div>
<div class="ttc" id="structpn__cbuf__t_html_aa6b3f44b7cf0eed9dc9f4a6cb51d56d8"><div class="ttname"><a href="structpn__cbuf__t.html#aa6b3f44b7cf0eed9dc9f4a6cb51d56d8">pn_cbuf_t::data</a></div><div class="ttdeci">const char * data</div><div class="ttdoc">Beginning of the buffered data. </div><div class="ttdef"><b>Definition:</b> connection_engine.h:82</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 4 2018 22:16:50 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|