/usr/share/doc/libjuce/apiref/classNamedPipe.html is in libjuce-doc 4.3.0~repack-1.
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 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: NamedPipe Class 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>
<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">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classNamedPipe-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NamedPipe Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A cross-process pipe that can have data written to and read from it.
<a href="classNamedPipe.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a81946cbcb2a7d0c979f5f7e1b565b4ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a81946cbcb2a7d0c979f5f7e1b565b4ab">NamedPipe</a> ()</td></tr>
<tr class="memdesc:a81946cbcb2a7d0c979f5f7e1b565b4ab"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classNamedPipe.html" title="A cross-process pipe that can have data written to and read from it. ">NamedPipe</a>. <a href="#a81946cbcb2a7d0c979f5f7e1b565b4ab">More...</a><br /></td></tr>
<tr class="separator:a81946cbcb2a7d0c979f5f7e1b565b4ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24ff787de22c7abe0ad7b556296d3b0b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a24ff787de22c7abe0ad7b556296d3b0b">~NamedPipe</a> ()</td></tr>
<tr class="memdesc:a24ff787de22c7abe0ad7b556296d3b0b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a24ff787de22c7abe0ad7b556296d3b0b">More...</a><br /></td></tr>
<tr class="separator:a24ff787de22c7abe0ad7b556296d3b0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fb5d29a7fcb0ab8dada0948c5d3e536"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a7fb5d29a7fcb0ab8dada0948c5d3e536">openExisting</a> (const <a class="el" href="classString.html">String</a> &pipeName)</td></tr>
<tr class="memdesc:a7fb5d29a7fcb0ab8dada0948c5d3e536"><td class="mdescLeft"> </td><td class="mdescRight">Tries to open a pipe that already exists. <a href="#a7fb5d29a7fcb0ab8dada0948c5d3e536">More...</a><br /></td></tr>
<tr class="separator:a7fb5d29a7fcb0ab8dada0948c5d3e536"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4aaea9d143f85b013fc29357d020135"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#ac4aaea9d143f85b013fc29357d020135">createNewPipe</a> (const <a class="el" href="classString.html">String</a> &pipeName, bool mustNotExist=false)</td></tr>
<tr class="memdesc:ac4aaea9d143f85b013fc29357d020135"><td class="mdescLeft"> </td><td class="mdescRight">Tries to create a new pipe. <a href="#ac4aaea9d143f85b013fc29357d020135">More...</a><br /></td></tr>
<tr class="separator:ac4aaea9d143f85b013fc29357d020135"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6b7c1b0efe76f82ca1eb90383391cdb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#ae6b7c1b0efe76f82ca1eb90383391cdb">close</a> ()</td></tr>
<tr class="memdesc:ae6b7c1b0efe76f82ca1eb90383391cdb"><td class="mdescLeft"> </td><td class="mdescRight">Closes the pipe, if it's open. <a href="#ae6b7c1b0efe76f82ca1eb90383391cdb">More...</a><br /></td></tr>
<tr class="separator:ae6b7c1b0efe76f82ca1eb90383391cdb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70a117f52746c29bcd905167a18643a3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a70a117f52746c29bcd905167a18643a3">isOpen</a> () const</td></tr>
<tr class="memdesc:a70a117f52746c29bcd905167a18643a3"><td class="mdescLeft"> </td><td class="mdescRight">True if the pipe is currently open. <a href="#a70a117f52746c29bcd905167a18643a3">More...</a><br /></td></tr>
<tr class="separator:a70a117f52746c29bcd905167a18643a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a935e60f02cc5c22368e51ede6867cf21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a935e60f02cc5c22368e51ede6867cf21">getName</a> () const</td></tr>
<tr class="memdesc:a935e60f02cc5c22368e51ede6867cf21"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last name that was used to try to open this pipe. <a href="#a935e60f02cc5c22368e51ede6867cf21">More...</a><br /></td></tr>
<tr class="separator:a935e60f02cc5c22368e51ede6867cf21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5223fb46357279d84e2f97d43291b3a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#a5223fb46357279d84e2f97d43291b3a8">read</a> (void *destBuffer, int maxBytesToRead, int timeOutMilliseconds)</td></tr>
<tr class="memdesc:a5223fb46357279d84e2f97d43291b3a8"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from the pipe. <a href="#a5223fb46357279d84e2f97d43291b3a8">More...</a><br /></td></tr>
<tr class="separator:a5223fb46357279d84e2f97d43291b3a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa091d109e18d5b9ae5fb0f4a03cdf743"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNamedPipe.html#aa091d109e18d5b9ae5fb0f4a03cdf743">write</a> (const void *sourceBuffer, int numBytesToWrite, int timeOutMilliseconds)</td></tr>
<tr class="memdesc:aa091d109e18d5b9ae5fb0f4a03cdf743"><td class="mdescLeft"> </td><td class="mdescRight">Writes some data to the pipe. <a href="#aa091d109e18d5b9ae5fb0f4a03cdf743">More...</a><br /></td></tr>
<tr class="separator:aa091d109e18d5b9ae5fb0f4a03cdf743"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A cross-process pipe that can have data written to and read from it. </p>
<p>Two processes can use <a class="el" href="classNamedPipe.html" title="A cross-process pipe that can have data written to and read from it. ">NamedPipe</a> objects to exchange blocks of data.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnection.html" title="Manages a simple two-way messaging connection to another process, using either a socket or a named pi...">InterprocessConnection</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a81946cbcb2a7d0c979f5f7e1b565b4ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81946cbcb2a7d0c979f5f7e1b565b4ab">§ </a></span>NamedPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NamedPipe::NamedPipe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classNamedPipe.html" title="A cross-process pipe that can have data written to and read from it. ">NamedPipe</a>. </p>
</div>
</div>
<a id="a24ff787de22c7abe0ad7b556296d3b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24ff787de22c7abe0ad7b556296d3b0b">§ </a></span>~NamedPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NamedPipe::~NamedPipe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7fb5d29a7fcb0ab8dada0948c5d3e536"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fb5d29a7fcb0ab8dada0948c5d3e536">§ </a></span>openExisting()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NamedPipe::openExisting </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>pipeName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to open a pipe that already exists. </p>
<p>Returns true if it succeeds. </p>
</div>
</div>
<a id="ac4aaea9d143f85b013fc29357d020135"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4aaea9d143f85b013fc29357d020135">§ </a></span>createNewPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NamedPipe::createNewPipe </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>pipeName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>mustNotExist</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to create a new pipe. </p>
<p>Returns true if it succeeds. If mustNotExist is true then it will fail if a pipe is already open with the same name. </p>
</div>
</div>
<a id="ae6b7c1b0efe76f82ca1eb90383391cdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6b7c1b0efe76f82ca1eb90383391cdb">§ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NamedPipe::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the pipe, if it's open. </p>
</div>
</div>
<a id="a70a117f52746c29bcd905167a18643a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70a117f52746c29bcd905167a18643a3">§ </a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NamedPipe::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the pipe is currently open. </p>
</div>
</div>
<a id="a935e60f02cc5c22368e51ede6867cf21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a935e60f02cc5c22368e51ede6867cf21">§ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> NamedPipe::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the last name that was used to try to open this pipe. </p>
</div>
</div>
<a id="a5223fb46357279d84e2f97d43291b3a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5223fb46357279d84e2f97d43291b3a8">§ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NamedPipe::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>destBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxBytesToRead</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeOutMilliseconds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads data from the pipe. </p>
<p>This will block until another thread has written enough data into the pipe to fill the number of bytes specified, or until another thread calls the cancelPendingReads() method.</p>
<p>If the operation fails, it returns -1, otherwise, it will return the number of bytes read.</p>
<p>If timeOutMilliseconds is less than zero, it will wait indefinitely, otherwise this is a maximum timeout for reading from the pipe. </p>
</div>
</div>
<a id="aa091d109e18d5b9ae5fb0f4a03cdf743"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa091d109e18d5b9ae5fb0f4a03cdf743">§ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NamedPipe::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>sourceBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numBytesToWrite</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeOutMilliseconds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes some data to the pipe. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written, or -1 on failure. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__NamedPipe_8h.html">juce_NamedPipe.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|