/usr/share/doc/libneo4j-client/structneo4j__iostream.html is in libneo4j-client-doc 2.2.0-1build1.
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 | <!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>libneo4j-client-2.2.0: neo4j_iostream Struct 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="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">libneo4j-client-2.2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">neo4j_iostream Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An I/O stream for neo4j client.
<a href="structneo4j__iostream.html#details">More...</a></p>
<p><code>#include <neo4j-client.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a10b136363575dfd65e9121f4c1807834"><td class="memItemLeft" align="right" valign="top">ssize_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#a10b136363575dfd65e9121f4c1807834">read</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, void *buf, size_t nbyte)</td></tr>
<tr class="memdesc:a10b136363575dfd65e9121f4c1807834"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes from a stream into the supplied buffer. <a href="#a10b136363575dfd65e9121f4c1807834">More...</a><br /></td></tr>
<tr class="separator:a10b136363575dfd65e9121f4c1807834"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa247479b08283ddabf0f929b65a11f2c"><td class="memItemLeft" align="right" valign="top">ssize_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#aa247479b08283ddabf0f929b65a11f2c">readv</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const struct iovec *iov, unsigned int iovcnt)</td></tr>
<tr class="memdesc:aa247479b08283ddabf0f929b65a11f2c"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes from a stream into the supplied I/O vector. <a href="#aa247479b08283ddabf0f929b65a11f2c">More...</a><br /></td></tr>
<tr class="separator:aa247479b08283ddabf0f929b65a11f2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e31656cf972062a6b4dbe1765567b9d"><td class="memItemLeft" align="right" valign="top">ssize_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#a6e31656cf972062a6b4dbe1765567b9d">write</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const void *buf, size_t nbyte)</td></tr>
<tr class="memdesc:a6e31656cf972062a6b4dbe1765567b9d"><td class="mdescLeft"> </td><td class="mdescRight">Write bytes to a stream from the supplied buffer. <a href="#a6e31656cf972062a6b4dbe1765567b9d">More...</a><br /></td></tr>
<tr class="separator:a6e31656cf972062a6b4dbe1765567b9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5021188d28ede3a73a349c50f90bea77"><td class="memItemLeft" align="right" valign="top">ssize_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#a5021188d28ede3a73a349c50f90bea77">writev</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const struct iovec *iov, unsigned int iovcnt)</td></tr>
<tr class="memdesc:a5021188d28ede3a73a349c50f90bea77"><td class="mdescLeft"> </td><td class="mdescRight">Write bytes to a stream ifrom the supplied I/O vector. <a href="#a5021188d28ede3a73a349c50f90bea77">More...</a><br /></td></tr>
<tr class="separator:a5021188d28ede3a73a349c50f90bea77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab63cdef40e104e99a286b11ebff016e9"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#ab63cdef40e104e99a286b11ebff016e9">flush</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self)</td></tr>
<tr class="memdesc:ab63cdef40e104e99a286b11ebff016e9"><td class="mdescLeft"> </td><td class="mdescRight">Flush the output buffer of the iostream. <a href="#ab63cdef40e104e99a286b11ebff016e9">More...</a><br /></td></tr>
<tr class="separator:ab63cdef40e104e99a286b11ebff016e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa97e04ee5954f4441214f7a140866bc4"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structneo4j__iostream.html#aa97e04ee5954f4441214f7a140866bc4">close</a> )(struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self)</td></tr>
<tr class="memdesc:aa97e04ee5954f4441214f7a140866bc4"><td class="mdescLeft"> </td><td class="mdescRight">Close the stream. <a href="#aa97e04ee5954f4441214f7a140866bc4">More...</a><br /></td></tr>
<tr class="separator:aa97e04ee5954f4441214f7a140866bc4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An I/O stream for neo4j client. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa97e04ee5954f4441214f7a140866bc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa97e04ee5954f4441214f7a140866bc4">◆ </a></span>close</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* neo4j_iostream::close) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the stream. </p>
<p>This function should close the stream and deallocate memory associated with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
<a id="ab63cdef40e104e99a286b11ebff016e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab63cdef40e104e99a286b11ebff016e9">◆ </a></span>flush</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* neo4j_iostream::flush) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the output buffer of the iostream. </p>
<p>For unbuffered streams, this is a no-op.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
<a id="a10b136363575dfd65e9121f4c1807834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b136363575dfd65e9121f4c1807834">◆ </a></span>read</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t(* neo4j_iostream::read) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, void *buf, size_t nbyte)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read bytes from a stream into the supplied buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
<tr><td class="paramname">[buf]</td><td>A pointer to a memory buffer to read into. </td></tr>
<tr><td class="paramname">[nbyte]</td><td>The size of the memory buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bytes read, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
<a id="aa247479b08283ddabf0f929b65a11f2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa247479b08283ddabf0f929b65a11f2c">◆ </a></span>readv</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t(* neo4j_iostream::readv) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const struct iovec *iov, unsigned int iovcnt)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read bytes from a stream into the supplied I/O vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
<tr><td class="paramname">[iov]</td><td>A pointer to the I/O vector. </td></tr>
<tr><td class="paramname">[iovcnt]</td><td>The length of the I/O vector. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bytes read, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
<a id="a6e31656cf972062a6b4dbe1765567b9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e31656cf972062a6b4dbe1765567b9d">◆ </a></span>write</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t(* neo4j_iostream::write) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const void *buf, size_t nbyte)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Write bytes to a stream from the supplied buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
<tr><td class="paramname">[buf]</td><td>A pointer to a memory buffer to read from. </td></tr>
<tr><td class="paramname">[nbyte]</td><td>The size of the memory buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bytes written, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
<a id="a5021188d28ede3a73a349c50f90bea77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5021188d28ede3a73a349c50f90bea77">◆ </a></span>writev</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t(* neo4j_iostream::writev) (struct <a class="el" href="structneo4j__iostream.html">neo4j_iostream</a> *self, const struct iovec *iov, unsigned int iovcnt)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Write bytes to a stream ifrom the supplied I/O vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">[self]</td><td>This stream. </td></tr>
<tr><td class="paramname">[iov]</td><td>A pointer to the I/O vector. </td></tr>
<tr><td class="paramname">[iovcnt]</td><td>The length of the I/O vector. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bytes written, or -1 on error (errno will be set). </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>
|