1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/api-2.1/structUcxBuffer.html Sat Feb 06 19:11:44 2021 +0100
1.3 @@ -0,0 +1,193 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
1.8 +<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1.9 +<meta name="generator" content="Doxygen 1.8.13"/>
1.10 +<meta name="viewport" content="width=device-width, initial-scale=1"/>
1.11 +<title>ucx: UcxBuffer Struct Reference</title>
1.12 +<link href="tabs.css" rel="stylesheet" type="text/css"/>
1.13 +<script type="text/javascript" src="jquery.js"></script>
1.14 +<script type="text/javascript" src="dynsections.js"></script>
1.15 +<link href="search/search.css" rel="stylesheet" type="text/css"/>
1.16 +<script type="text/javascript" src="search/searchdata.js"></script>
1.17 +<script type="text/javascript" src="search/search.js"></script>
1.18 +<link href="doxygen.css" rel="stylesheet" type="text/css" />
1.19 +</head>
1.20 +<body>
1.21 +<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
1.22 +<div id="titlearea">
1.23 +<table cellspacing="0" cellpadding="0">
1.24 + <tbody>
1.25 + <tr style="height: 56px;">
1.26 + <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
1.27 + <td id="projectalign" style="padding-left: 0.5em;">
1.28 + <div id="projectname">ucx
1.29 + </div>
1.30 + <div id="projectbrief">UAP Common Extensions</div>
1.31 + </td>
1.32 + </tr>
1.33 + </tbody>
1.34 +</table>
1.35 +</div>
1.36 +<!-- end header part -->
1.37 +<!-- Generated by Doxygen 1.8.13 -->
1.38 +<script type="text/javascript">
1.39 +var searchBox = new SearchBox("searchBox", "search",false,'Search');
1.40 +</script>
1.41 +<script type="text/javascript" src="menudata.js"></script>
1.42 +<script type="text/javascript" src="menu.js"></script>
1.43 +<script type="text/javascript">
1.44 +$(function() {
1.45 + initMenu('',true,false,'search.php','Search');
1.46 + $(document).ready(function() { init_search(); });
1.47 +});
1.48 +</script>
1.49 +<div id="main-nav"></div>
1.50 +<!-- window showing the filter options -->
1.51 +<div id="MSearchSelectWindow"
1.52 + onmouseover="return searchBox.OnSearchSelectShow()"
1.53 + onmouseout="return searchBox.OnSearchSelectHide()"
1.54 + onkeydown="return searchBox.OnSearchSelectKey(event)">
1.55 +</div>
1.56 +
1.57 +<!-- iframe showing the search results (closed by default) -->
1.58 +<div id="MSearchResultsWindow">
1.59 +<iframe src="javascript:void(0)" frameborder="0"
1.60 + name="MSearchResults" id="MSearchResults">
1.61 +</iframe>
1.62 +</div>
1.63 +
1.64 +</div><!-- top -->
1.65 +<div class="header">
1.66 + <div class="summary">
1.67 +<a href="#pub-attribs">Data Fields</a> </div>
1.68 + <div class="headertitle">
1.69 +<div class="title">UcxBuffer Struct Reference</div> </div>
1.70 +</div><!--header-->
1.71 +<div class="contents">
1.72 +
1.73 +<p>UCX Buffer.
1.74 + <a href="structUcxBuffer.html#details">More...</a></p>
1.75 +
1.76 +<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p>
1.77 +<table class="memberdecls">
1.78 +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
1.79 +Data Fields</h2></td></tr>
1.80 +<tr class="memitem:a1a5076e85acb84b715a53bc0f37fb721"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxBuffer.html#a1a5076e85acb84b715a53bc0f37fb721">space</a></td></tr>
1.81 +<tr class="memdesc:a1a5076e85acb84b715a53bc0f37fb721"><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the buffer contents. <a href="#a1a5076e85acb84b715a53bc0f37fb721">More...</a><br /></td></tr>
1.82 +<tr class="separator:a1a5076e85acb84b715a53bc0f37fb721"><td class="memSeparator" colspan="2"> </td></tr>
1.83 +<tr class="memitem:a7a64288f002cf62b492e2ea49c79615c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxBuffer.html#a7a64288f002cf62b492e2ea49c79615c">pos</a></td></tr>
1.84 +<tr class="memdesc:a7a64288f002cf62b492e2ea49c79615c"><td class="mdescLeft"> </td><td class="mdescRight">Current position of the buffer. <a href="#a7a64288f002cf62b492e2ea49c79615c">More...</a><br /></td></tr>
1.85 +<tr class="separator:a7a64288f002cf62b492e2ea49c79615c"><td class="memSeparator" colspan="2"> </td></tr>
1.86 +<tr class="memitem:a385661894f3cee9c549bfe07a8b316bf"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxBuffer.html#a385661894f3cee9c549bfe07a8b316bf">capacity</a></td></tr>
1.87 +<tr class="memdesc:a385661894f3cee9c549bfe07a8b316bf"><td class="mdescLeft"> </td><td class="mdescRight">Current capacity (i.e. <a href="#a385661894f3cee9c549bfe07a8b316bf">More...</a><br /></td></tr>
1.88 +<tr class="separator:a385661894f3cee9c549bfe07a8b316bf"><td class="memSeparator" colspan="2"> </td></tr>
1.89 +<tr class="memitem:aec0aea8325394951d5ad4a9fbb8e1ac7"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxBuffer.html#aec0aea8325394951d5ad4a9fbb8e1ac7">size</a></td></tr>
1.90 +<tr class="memdesc:aec0aea8325394951d5ad4a9fbb8e1ac7"><td class="mdescLeft"> </td><td class="mdescRight">Current size of the buffer content. <a href="#aec0aea8325394951d5ad4a9fbb8e1ac7">More...</a><br /></td></tr>
1.91 +<tr class="separator:aec0aea8325394951d5ad4a9fbb8e1ac7"><td class="memSeparator" colspan="2"> </td></tr>
1.92 +<tr class="memitem:ac642e07b0a03be5aac48eb4aa5bec2f7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxBuffer.html#ac642e07b0a03be5aac48eb4aa5bec2f7">flags</a></td></tr>
1.93 +<tr class="memdesc:ac642e07b0a03be5aac48eb4aa5bec2f7"><td class="mdescLeft"> </td><td class="mdescRight">Flag register for buffer features. <a href="#ac642e07b0a03be5aac48eb4aa5bec2f7">More...</a><br /></td></tr>
1.94 +<tr class="separator:ac642e07b0a03be5aac48eb4aa5bec2f7"><td class="memSeparator" colspan="2"> </td></tr>
1.95 +</table>
1.96 +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1.97 +<div class="textblock"><p>UCX Buffer. </p>
1.98 +</div><h2 class="groupheader">Field Documentation</h2>
1.99 +<a id="a385661894f3cee9c549bfe07a8b316bf"></a>
1.100 +<h2 class="memtitle"><span class="permalink"><a href="#a385661894f3cee9c549bfe07a8b316bf">◆ </a></span>capacity</h2>
1.101 +
1.102 +<div class="memitem">
1.103 +<div class="memproto">
1.104 + <table class="memname">
1.105 + <tr>
1.106 + <td class="memname">size_t UcxBuffer::capacity</td>
1.107 + </tr>
1.108 + </table>
1.109 +</div><div class="memdoc">
1.110 +
1.111 +<p>Current capacity (i.e. </p>
1.112 +<p>maximum size) of the buffer. </p>
1.113 +
1.114 +</div>
1.115 +</div>
1.116 +<a id="ac642e07b0a03be5aac48eb4aa5bec2f7"></a>
1.117 +<h2 class="memtitle"><span class="permalink"><a href="#ac642e07b0a03be5aac48eb4aa5bec2f7">◆ </a></span>flags</h2>
1.118 +
1.119 +<div class="memitem">
1.120 +<div class="memproto">
1.121 + <table class="memname">
1.122 + <tr>
1.123 + <td class="memname">int UcxBuffer::flags</td>
1.124 + </tr>
1.125 + </table>
1.126 +</div><div class="memdoc">
1.127 +
1.128 +<p>Flag register for buffer features. </p>
1.129 +<dl class="section see"><dt>See also</dt><dd><a class="el" href="buffer_8h.html#acc77c8ed7b26854f555d4a5d11e49ea2" title="No buffer features enabled (all flags cleared). ">UCX_BUFFER_DEFAULT</a> </dd>
1.130 +<dd>
1.131 +<a class="el" href="buffer_8h.html#a8bab11ad8a76719228b9ee91e2e45535" title="If this flag is enabled, the buffer will automatically free its contents. ">UCX_BUFFER_AUTOFREE</a> </dd>
1.132 +<dd>
1.133 +<a class="el" href="buffer_8h.html#a05f9565f2d04399168c3b1c152a632be" title="If this flag is enabled, the buffer will automatically extends its capacity. ">UCX_BUFFER_AUTOEXTEND</a> </dd></dl>
1.134 +
1.135 +</div>
1.136 +</div>
1.137 +<a id="a7a64288f002cf62b492e2ea49c79615c"></a>
1.138 +<h2 class="memtitle"><span class="permalink"><a href="#a7a64288f002cf62b492e2ea49c79615c">◆ </a></span>pos</h2>
1.139 +
1.140 +<div class="memitem">
1.141 +<div class="memproto">
1.142 + <table class="memname">
1.143 + <tr>
1.144 + <td class="memname">size_t UcxBuffer::pos</td>
1.145 + </tr>
1.146 + </table>
1.147 +</div><div class="memdoc">
1.148 +
1.149 +<p>Current position of the buffer. </p>
1.150 +
1.151 +</div>
1.152 +</div>
1.153 +<a id="aec0aea8325394951d5ad4a9fbb8e1ac7"></a>
1.154 +<h2 class="memtitle"><span class="permalink"><a href="#aec0aea8325394951d5ad4a9fbb8e1ac7">◆ </a></span>size</h2>
1.155 +
1.156 +<div class="memitem">
1.157 +<div class="memproto">
1.158 + <table class="memname">
1.159 + <tr>
1.160 + <td class="memname">size_t UcxBuffer::size</td>
1.161 + </tr>
1.162 + </table>
1.163 +</div><div class="memdoc">
1.164 +
1.165 +<p>Current size of the buffer content. </p>
1.166 +
1.167 +</div>
1.168 +</div>
1.169 +<a id="a1a5076e85acb84b715a53bc0f37fb721"></a>
1.170 +<h2 class="memtitle"><span class="permalink"><a href="#a1a5076e85acb84b715a53bc0f37fb721">◆ </a></span>space</h2>
1.171 +
1.172 +<div class="memitem">
1.173 +<div class="memproto">
1.174 + <table class="memname">
1.175 + <tr>
1.176 + <td class="memname">char* UcxBuffer::space</td>
1.177 + </tr>
1.178 + </table>
1.179 +</div><div class="memdoc">
1.180 +
1.181 +<p>A pointer to the buffer contents. </p>
1.182 +
1.183 +</div>
1.184 +</div>
1.185 +<hr/>The documentation for this struct was generated from the following file:<ul>
1.186 +<li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="buffer_8h_source.html">buffer.h</a></li>
1.187 +</ul>
1.188 +</div><!-- contents -->
1.189 +<!-- start footer part -->
1.190 +<hr class="footer"/><address class="footer"><small>
1.191 +Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html">
1.192 +<img class="footer" src="doxygen.png" alt="doxygen"/>
1.193 +</a> 1.8.13
1.194 +</small></address>
1.195 +</body>
1.196 +</html>
