structUcxBuffer.html - UNIXwork Code

1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2 <html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 6 <meta name="generator" content="Doxygen 1.8.13"/> 7 <meta name="viewport" content="width=device-width, initial-scale=1"/> 8 <title>ucx: UcxBuffer Struct Reference</title> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/> 10 <script type="text/javascript" src="jquery.js"></script> 11 <script type="text/javascript" src="dynsections.js"></script> 12 <link href="search/search.css" rel="stylesheet" type="text/css"/> 13 <script type="text/javascript" src="search/searchdata.js"></script> 14 <script type="text/javascript" src="search/search.js"></script> 15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 16 </head> 17 <body> 18 <div id="top"> 19 <div id="titlearea"> 20 <table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td> 24 <td id="projectalign" style="padding-left: 0.5em;"> 25 <div id="projectname">ucx 26 </div> 27 <div id="projectbrief">UAP Common Extensions</div> 28 </td> 29 </tr> 30 </tbody> 31 </table> 32 </div> 33  34  35 <script type="text/javascript"> 36 var searchBox = new SearchBox("searchBox", "search",false,'Search'); 37 </script> 38 <script type="text/javascript" src="menudata.js"></script> 39 <script type="text/javascript" src="menu.js"></script> 40 <script type="text/javascript"> 41 $(function() { 42 initMenu('',true,false,'search.php','Search'); 43 $(document).ready(function() { init_search(); }); 44 }); 45 </script> 46 <div id="main-nav"></div> 47  48 <div id="MSearchSelectWindow" 49 onmouseover="return searchBox.OnSearchSelectShow()" 50 onmouseout="return searchBox.OnSearchSelectHide()" 51 onkeydown="return searchBox.OnSearchSelectKey(event)"> 52 </div> 53 54  55 <div id="MSearchResultsWindow"> 56 <iframe src="javascript:void(0)" frameborder="0" 57 name="MSearchResults" id="MSearchResults"> 58 </iframe> 59 </div> 60 61 </div> 62 <div class="header"> 63 <div class="summary"> 64 <a href="#pub-attribs">Data Fields</a> </div> 65 <div class="headertitle"> 66 <div class="title">UcxBuffer Struct Reference</div> </div> 67 </div> 68 <div class="contents"> 69 70 <p>UCX Buffer. 71 <a href="structUcxBuffer.html#details">More...</a></p> 72 73 <p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p> 74 <table class="memberdecls"> 75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> 76 Data Fields</h2></td></tr> 77 <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> 78 <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> 79 <tr class="separator:a1a5076e85acb84b715a53bc0f37fb721"><td class="memSeparator" colspan="2"> </td></tr> 80 <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> 81 <tr class="memdesc:a7a64288f002cf62b492e2ea49c79615c"><td class="mdescLeft"> </td><td class="mdescRight">Current position of the buffer. <a href="#a7a64288f002cf62b492e2ea49c79615c">More...</a><br /></td></tr> 82 <tr class="separator:a7a64288f002cf62b492e2ea49c79615c"><td class="memSeparator" colspan="2"> </td></tr> 83 <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> 84 <tr class="memdesc:a385661894f3cee9c549bfe07a8b316bf"><td class="mdescLeft"> </td><td class="mdescRight">Current capacity (i.e. <a href="#a385661894f3cee9c549bfe07a8b316bf">More...</a><br /></td></tr> 85 <tr class="separator:a385661894f3cee9c549bfe07a8b316bf"><td class="memSeparator" colspan="2"> </td></tr> 86 <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> 87 <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> 88 <tr class="separator:aec0aea8325394951d5ad4a9fbb8e1ac7"><td class="memSeparator" colspan="2"> </td></tr> 89 <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> 90 <tr class="memdesc:ac642e07b0a03be5aac48eb4aa5bec2f7"><td class="mdescLeft"> </td><td class="mdescRight">Flag register for buffer features. <a href="#ac642e07b0a03be5aac48eb4aa5bec2f7">More...</a><br /></td></tr> 91 <tr class="separator:ac642e07b0a03be5aac48eb4aa5bec2f7"><td class="memSeparator" colspan="2"> </td></tr> 92 </table> 93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 94 <div class="textblock"><p>UCX Buffer. </p> 95 </div><h2 class="groupheader">Field Documentation</h2> 96 <a id="a385661894f3cee9c549bfe07a8b316bf"></a> 97 <h2 class="memtitle"><span class="permalink"><a href="#a385661894f3cee9c549bfe07a8b316bf">◆ </a></span>capacity</h2> 98 99 <div class="memitem"> 100 <div class="memproto"> 101 <table class="memname"> 102 <tr> 103 <td class="memname">size_t UcxBuffer::capacity</td> 104 </tr> 105 </table> 106 </div><div class="memdoc"> 107 108 <p>Current capacity (i.e. </p> 109 <p>maximum size) of the buffer. </p> 110 111 </div> 112 </div> 113 <a id="ac642e07b0a03be5aac48eb4aa5bec2f7"></a> 114 <h2 class="memtitle"><span class="permalink"><a href="#ac642e07b0a03be5aac48eb4aa5bec2f7">◆ </a></span>flags</h2> 115 116 <div class="memitem"> 117 <div class="memproto"> 118 <table class="memname"> 119 <tr> 120 <td class="memname">int UcxBuffer::flags</td> 121 </tr> 122 </table> 123 </div><div class="memdoc"> 124 125 <p>Flag register for buffer features. </p> 126 <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> 127 <dd> 128 <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> 129 <dd> 130 <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> 131 132 </div> 133 </div> 134 <a id="a7a64288f002cf62b492e2ea49c79615c"></a> 135 <h2 class="memtitle"><span class="permalink"><a href="#a7a64288f002cf62b492e2ea49c79615c">◆ </a></span>pos</h2> 136 137 <div class="memitem"> 138 <div class="memproto"> 139 <table class="memname"> 140 <tr> 141 <td class="memname">size_t UcxBuffer::pos</td> 142 </tr> 143 </table> 144 </div><div class="memdoc"> 145 146 <p>Current position of the buffer. </p> 147 148 </div> 149 </div> 150 <a id="aec0aea8325394951d5ad4a9fbb8e1ac7"></a> 151 <h2 class="memtitle"><span class="permalink"><a href="#aec0aea8325394951d5ad4a9fbb8e1ac7">◆ </a></span>size</h2> 152 153 <div class="memitem"> 154 <div class="memproto"> 155 <table class="memname"> 156 <tr> 157 <td class="memname">size_t UcxBuffer::size</td> 158 </tr> 159 </table> 160 </div><div class="memdoc"> 161 162 <p>Current size of the buffer content. </p> 163 164 </div> 165 </div> 166 <a id="a1a5076e85acb84b715a53bc0f37fb721"></a> 167 <h2 class="memtitle"><span class="permalink"><a href="#a1a5076e85acb84b715a53bc0f37fb721">◆ </a></span>space</h2> 168 169 <div class="memitem"> 170 <div class="memproto"> 171 <table class="memname"> 172 <tr> 173 <td class="memname">char* UcxBuffer::space</td> 174 </tr> 175 </table> 176 </div><div class="memdoc"> 177 178 <p>A pointer to the buffer contents. </p> 179 180 </div> 181 </div> 182 <hr/>The documentation for this struct was generated from the following file:<ul> 183 <li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="buffer_8h_source.html">buffer.h</a></li> 184 </ul> 185 </div> 186  187 <hr class="footer"/><address class="footer"><small> 188 Generated on Thu Dec 19 2019 19:58:24 for ucx by  <a href="http://www.doxygen.org/index.html"> 189 <img class="footer" src="doxygen.png" alt="doxygen"/> 190 </a> 1.8.13 191 </small></address> 192 </body> 193 </html> 194

UNIXworkcode

UNIXwork`code`