/usr/share/doc/libjuce/apiref/classInterprocessConnection.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 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 | <!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: InterprocessConnection 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="classInterprocessConnection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">InterprocessConnection Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Manages a simple two-way messaging connection to another process, using either a socket or a named pipe as the transport medium.
<a href="classInterprocessConnection.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:a31dc05e077ee562d5ca96ecea09c3663"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a31dc05e077ee562d5ca96ecea09c3663">InterprocessConnection</a> (bool callbacksOnMessageThread=true, <a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> magicMessageHeaderNumber=0xf2b49e2c)</td></tr>
<tr class="memdesc:a31dc05e077ee562d5ca96ecea09c3663"><td class="mdescLeft"> </td><td class="mdescRight">Creates a connection. <a href="#a31dc05e077ee562d5ca96ecea09c3663">More...</a><br /></td></tr>
<tr class="separator:a31dc05e077ee562d5ca96ecea09c3663"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04a6ad194ee3b4a4aaac4fcd531f2a6d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a04a6ad194ee3b4a4aaac4fcd531f2a6d">~InterprocessConnection</a> ()</td></tr>
<tr class="memdesc:a04a6ad194ee3b4a4aaac4fcd531f2a6d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a04a6ad194ee3b4a4aaac4fcd531f2a6d">More...</a><br /></td></tr>
<tr class="separator:a04a6ad194ee3b4a4aaac4fcd531f2a6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a007450a6ca6dc60bb48d384479d9a49d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a007450a6ca6dc60bb48d384479d9a49d">connectToSocket</a> (const <a class="el" href="classString.html">String</a> &hostName, int portNumber, int timeOutMillisecs)</td></tr>
<tr class="memdesc:a007450a6ca6dc60bb48d384479d9a49d"><td class="mdescLeft"> </td><td class="mdescRight">Tries to connect this object to a socket. <a href="#a007450a6ca6dc60bb48d384479d9a49d">More...</a><br /></td></tr>
<tr class="separator:a007450a6ca6dc60bb48d384479d9a49d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abafb2228ed136a2b34e2de03709eb9a7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#abafb2228ed136a2b34e2de03709eb9a7">connectToPipe</a> (const <a class="el" href="classString.html">String</a> &pipeName, int pipeReceiveMessageTimeoutMs)</td></tr>
<tr class="memdesc:abafb2228ed136a2b34e2de03709eb9a7"><td class="mdescLeft"> </td><td class="mdescRight">Tries to connect the object to an existing named pipe. <a href="#abafb2228ed136a2b34e2de03709eb9a7">More...</a><br /></td></tr>
<tr class="separator:abafb2228ed136a2b34e2de03709eb9a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e073a6609a68de2e4fcc892c1d003c0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a0e073a6609a68de2e4fcc892c1d003c0">createPipe</a> (const <a class="el" href="classString.html">String</a> &pipeName, int pipeReceiveMessageTimeoutMs, bool mustNotExist=false)</td></tr>
<tr class="memdesc:a0e073a6609a68de2e4fcc892c1d003c0"><td class="mdescLeft"> </td><td class="mdescRight">Tries to create a new pipe for other processes to connect to. <a href="#a0e073a6609a68de2e4fcc892c1d003c0">More...</a><br /></td></tr>
<tr class="separator:a0e073a6609a68de2e4fcc892c1d003c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16959b067e088c75663fcff8633d600f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a16959b067e088c75663fcff8633d600f">disconnect</a> ()</td></tr>
<tr class="memdesc:a16959b067e088c75663fcff8633d600f"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects and closes any currently-open sockets or pipes. <a href="#a16959b067e088c75663fcff8633d600f">More...</a><br /></td></tr>
<tr class="separator:a16959b067e088c75663fcff8633d600f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7573d93baabda5ddc4bcae463040c895"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a7573d93baabda5ddc4bcae463040c895">isConnected</a> () const</td></tr>
<tr class="memdesc:a7573d93baabda5ddc4bcae463040c895"><td class="mdescLeft"> </td><td class="mdescRight">True if a socket or pipe is currently active. <a href="#a7573d93baabda5ddc4bcae463040c895">More...</a><br /></td></tr>
<tr class="separator:a7573d93baabda5ddc4bcae463040c895"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bee6edc518378ac8c5639ae517535eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStreamingSocket.html">StreamingSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a1bee6edc518378ac8c5639ae517535eb">getSocket</a> () const noexcept</td></tr>
<tr class="memdesc:a1bee6edc518378ac8c5639ae517535eb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the socket that this connection is using (or nullptr if it uses a pipe). <a href="#a1bee6edc518378ac8c5639ae517535eb">More...</a><br /></td></tr>
<tr class="separator:a1bee6edc518378ac8c5639ae517535eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc220aa35a0b727979279f5557c0f2d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classNamedPipe.html">NamedPipe</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#abc220aa35a0b727979279f5557c0f2d1">getPipe</a> () const noexcept</td></tr>
<tr class="memdesc:abc220aa35a0b727979279f5557c0f2d1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pipe that this connection is using (or nullptr if it uses a socket). <a href="#abc220aa35a0b727979279f5557c0f2d1">More...</a><br /></td></tr>
<tr class="separator:abc220aa35a0b727979279f5557c0f2d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ae0f80ddafe4bf281b97c28b0247b84"><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="classInterprocessConnection.html#a7ae0f80ddafe4bf281b97c28b0247b84">getConnectedHostName</a> () const</td></tr>
<tr class="memdesc:a7ae0f80ddafe4bf281b97c28b0247b84"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the machine at the other end of this connection. <a href="#a7ae0f80ddafe4bf281b97c28b0247b84">More...</a><br /></td></tr>
<tr class="separator:a7ae0f80ddafe4bf281b97c28b0247b84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fc9e7b55c25eac48baebd131ded9d4f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a6fc9e7b55c25eac48baebd131ded9d4f">sendMessage</a> (const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> &message)</td></tr>
<tr class="memdesc:a6fc9e7b55c25eac48baebd131ded9d4f"><td class="mdescLeft"> </td><td class="mdescRight">Tries to send a message to the other end of this connection. <a href="#a6fc9e7b55c25eac48baebd131ded9d4f">More...</a><br /></td></tr>
<tr class="separator:a6fc9e7b55c25eac48baebd131ded9d4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6491a1c39849ecbdb6093965cfd47b03"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a6491a1c39849ecbdb6093965cfd47b03">connectionMade</a> ()=0</td></tr>
<tr class="memdesc:a6491a1c39849ecbdb6093965cfd47b03"><td class="mdescLeft"> </td><td class="mdescRight">Called when the connection is first connected. <a href="#a6491a1c39849ecbdb6093965cfd47b03">More...</a><br /></td></tr>
<tr class="separator:a6491a1c39849ecbdb6093965cfd47b03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83bf2f27d14ea3a9c7e1a88e18e31351"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a83bf2f27d14ea3a9c7e1a88e18e31351">connectionLost</a> ()=0</td></tr>
<tr class="memdesc:a83bf2f27d14ea3a9c7e1a88e18e31351"><td class="mdescLeft"> </td><td class="mdescRight">Called when the connection is broken. <a href="#a83bf2f27d14ea3a9c7e1a88e18e31351">More...</a><br /></td></tr>
<tr class="separator:a83bf2f27d14ea3a9c7e1a88e18e31351"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69549dd1bda0584d212940d3faf7457a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnection.html#a69549dd1bda0584d212940d3faf7457a">messageReceived</a> (const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> &message)=0</td></tr>
<tr class="memdesc:a69549dd1bda0584d212940d3faf7457a"><td class="mdescLeft"> </td><td class="mdescRight">Called when a message arrives. <a href="#a69549dd1bda0584d212940d3faf7457a">More...</a><br /></td></tr>
<tr class="separator:a69549dd1bda0584d212940d3faf7457a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages a simple two-way messaging connection to another process, using either a socket or a named pipe as the transport medium. </p>
<p>To connect to a waiting socket or an open pipe, use the <a class="el" href="classInterprocessConnection.html#a007450a6ca6dc60bb48d384479d9a49d" title="Tries to connect this object to a socket. ">connectToSocket()</a> or <a class="el" href="classInterprocessConnection.html#abafb2228ed136a2b34e2de03709eb9a7" title="Tries to connect the object to an existing named pipe. ">connectToPipe()</a> methods. If this succeeds, messages can be sent to the other end, and incoming messages will result in a callback via the <a class="el" href="classInterprocessConnection.html#a69549dd1bda0584d212940d3faf7457a" title="Called when a message arrives. ">messageReceived()</a> method.</p>
<p>To open a pipe and wait for another client to connect to it, use the <a class="el" href="classInterprocessConnection.html#a0e073a6609a68de2e4fcc892c1d003c0" title="Tries to create a new pipe for other processes to connect to. ">createPipe()</a> method.</p>
<p>To act as a socket server and create connections for one or more client, see the <a class="el" href="classInterprocessConnectionServer.html" title="An object that waits for client sockets to connect to a port on this host, and creates InterprocessCo...">InterprocessConnectionServer</a> class.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnectionServer.html" title="An object that waits for client sockets to connect to a port on this host, and creates InterprocessCo...">InterprocessConnectionServer</a>, Socket, <a class="el" href="classNamedPipe.html" title="A cross-process pipe that can have data written to and read from it. ">NamedPipe</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a31dc05e077ee562d5ca96ecea09c3663"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31dc05e077ee562d5ca96ecea09c3663">§ </a></span>InterprocessConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InterprocessConnection::InterprocessConnection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>callbacksOnMessageThread</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"><em>magicMessageHeaderNumber</em> = <code>0xf2b49e2c</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a connection. </p>
<p>Connections are created manually, connecting them with the <a class="el" href="classInterprocessConnection.html#a007450a6ca6dc60bb48d384479d9a49d" title="Tries to connect this object to a socket. ">connectToSocket()</a> or <a class="el" href="classInterprocessConnection.html#abafb2228ed136a2b34e2de03709eb9a7" title="Tries to connect the object to an existing named pipe. ">connectToPipe()</a> methods, or they are created automatically by a <a class="el" href="classInterprocessConnectionServer.html" title="An object that waits for client sockets to connect to a port on this host, and creates InterprocessCo...">InterprocessConnectionServer</a> when a client wants to connect.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callbacksOnMessageThread</td><td>if true, callbacks to the <a class="el" href="classInterprocessConnection.html#a6491a1c39849ecbdb6093965cfd47b03" title="Called when the connection is first connected. ">connectionMade()</a>, <a class="el" href="classInterprocessConnection.html#a83bf2f27d14ea3a9c7e1a88e18e31351" title="Called when the connection is broken. ">connectionLost()</a> and <a class="el" href="classInterprocessConnection.html#a69549dd1bda0584d212940d3faf7457a" title="Called when a message arrives. ">messageReceived()</a> methods will always be made using the message thread; if false, these will be called immediately on the connection's own thread. </td></tr>
<tr><td class="paramname">magicMessageHeaderNumber</td><td>a magic number to use in the header to check the validity of the data blocks being sent and received. This can be any number, but the sender and receiver must obviously use matching values or they won't recognise each other. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a04a6ad194ee3b4a4aaac4fcd531f2a6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04a6ad194ee3b4a4aaac4fcd531f2a6d">§ </a></span>~InterprocessConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual InterprocessConnection::~InterprocessConnection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a007450a6ca6dc60bb48d384479d9a49d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a007450a6ca6dc60bb48d384479d9a49d">§ </a></span>connectToSocket()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnection::connectToSocket </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>hostName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>portNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeOutMillisecs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to connect this object to a socket. </p>
<p>For this to work, the machine on the other end needs to have a <a class="el" href="classInterprocessConnectionServer.html" title="An object that waits for client sockets to connect to a port on this host, and creates InterprocessCo...">InterprocessConnectionServer</a> object waiting to receive client connections on this port number.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostName</td><td>the host computer, either a network address or name </td></tr>
<tr><td class="paramname">portNumber</td><td>the socket port number to try to connect to </td></tr>
<tr><td class="paramname">timeOutMillisecs</td><td>how long to keep trying before giving up </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the connection is established successfully </dd></dl>
<dl class="section see"><dt>See also</dt><dd>Socket </dd></dl>
</div>
</div>
<a id="abafb2228ed136a2b34e2de03709eb9a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abafb2228ed136a2b34e2de03709eb9a7">§ </a></span>connectToPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnection::connectToPipe </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">int </td>
<td class="paramname"><em>pipeReceiveMessageTimeoutMs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to connect the object to an existing named pipe. </p>
<p>For this to work, another process on the same computer must already have opened an <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> object and used <a class="el" href="classInterprocessConnection.html#a0e073a6609a68de2e4fcc892c1d003c0" title="Tries to create a new pipe for other processes to connect to. ">createPipe()</a> to create a pipe for this to connect to.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pipeName</td><td>the name to use for the pipe - this should be unique to your app </td></tr>
<tr><td class="paramname">pipeReceiveMessageTimeoutMs</td><td>a timeout length to be used when reading or writing to the pipe, or -1 for an infinite timeout. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if it connects successfully. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnection.html#a0e073a6609a68de2e4fcc892c1d003c0" title="Tries to create a new pipe for other processes to connect to. ">createPipe</a>, <a class="el" href="classNamedPipe.html" title="A cross-process pipe that can have data written to and read from it. ">NamedPipe</a> </dd></dl>
</div>
</div>
<a id="a0e073a6609a68de2e4fcc892c1d003c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e073a6609a68de2e4fcc892c1d003c0">§ </a></span>createPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnection::createPipe </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">int </td>
<td class="paramname"><em>pipeReceiveMessageTimeoutMs</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 for other processes to connect to. </p>
<p>This creates a pipe with the given name, so that other processes can use <a class="el" href="classInterprocessConnection.html#abafb2228ed136a2b34e2de03709eb9a7" title="Tries to connect the object to an existing named pipe. ">connectToPipe()</a> to connect to the other end.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pipeName</td><td>the name to use for the pipe - this should be unique to your app </td></tr>
<tr><td class="paramname">pipeReceiveMessageTimeoutMs</td><td>a timeout length to be used when reading or writing to the pipe, or -1 for an infinite timeout </td></tr>
<tr><td class="paramname">mustNotExist</td><td>if set to true, the method will fail if the pipe already exists </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the pipe was created, or false if it fails (e.g. if another process is already using using the pipe) </dd></dl>
</div>
</div>
<a id="a16959b067e088c75663fcff8633d600f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16959b067e088c75663fcff8633d600f">§ </a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void InterprocessConnection::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects and closes any currently-open sockets or pipes. </p>
</div>
</div>
<a id="a7573d93baabda5ddc4bcae463040c895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7573d93baabda5ddc4bcae463040c895">§ </a></span>isConnected()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnection::isConnected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if a socket or pipe is currently active. </p>
</div>
</div>
<a id="a1bee6edc518378ac8c5639ae517535eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bee6edc518378ac8c5639ae517535eb">§ </a></span>getSocket()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStreamingSocket.html">StreamingSocket</a>* InterprocessConnection::getSocket </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the socket that this connection is using (or nullptr if it uses a pipe). </p>
</div>
</div>
<a id="abc220aa35a0b727979279f5557c0f2d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc220aa35a0b727979279f5557c0f2d1">§ </a></span>getPipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNamedPipe.html">NamedPipe</a>* InterprocessConnection::getPipe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the pipe that this connection is using (or nullptr if it uses a socket). </p>
</div>
</div>
<a id="a7ae0f80ddafe4bf281b97c28b0247b84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ae0f80ddafe4bf281b97c28b0247b84">§ </a></span>getConnectedHostName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> InterprocessConnection::getConnectedHostName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the machine at the other end of this connection. </p>
<p>This may return an empty string if the name is unknown. </p>
</div>
</div>
<a id="a6fc9e7b55c25eac48baebd131ded9d4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fc9e7b55c25eac48baebd131ded9d4f">§ </a></span>sendMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnection::sendMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to send a message to the other end of this connection. </p>
<p>This will fail if it's not connected, or if there's some kind of write error. If it succeeds, the connection object at the other end will receive the message by a callback to its <a class="el" href="classInterprocessConnection.html#a69549dd1bda0584d212940d3faf7457a" title="Called when a message arrives. ">messageReceived()</a> method.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnection.html#a69549dd1bda0584d212940d3faf7457a" title="Called when a message arrives. ">messageReceived</a> </dd></dl>
</div>
</div>
<a id="a6491a1c39849ecbdb6093965cfd47b03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6491a1c39849ecbdb6093965cfd47b03">§ </a></span>connectionMade()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void InterprocessConnection::connectionMade </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the connection is first connected. </p>
<p>If the connection was created with the callbacksOnMessageThread flag set, then this will be called on the message thread; otherwise it will be called on a server thread. </p>
</div>
</div>
<a id="a83bf2f27d14ea3a9c7e1a88e18e31351"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83bf2f27d14ea3a9c7e1a88e18e31351">§ </a></span>connectionLost()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void InterprocessConnection::connectionLost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when the connection is broken. </p>
<p>If the connection was created with the callbacksOnMessageThread flag set, then this will be called on the message thread; otherwise it will be called on a server thread. </p>
</div>
</div>
<a id="a69549dd1bda0584d212940d3faf7457a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69549dd1bda0584d212940d3faf7457a">§ </a></span>messageReceived()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void InterprocessConnection::messageReceived </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a message arrives. </p>
<p>When the object at the other end of this connection sends us a message with <a class="el" href="classInterprocessConnection.html#a6fc9e7b55c25eac48baebd131ded9d4f" title="Tries to send a message to the other end of this connection. ">sendMessage()</a>, this callback is used to deliver it to us.</p>
<p>If the connection was created with the callbacksOnMessageThread flag set, then this will be called on the message thread; otherwise it will be called on a server thread.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnection.html#a6fc9e7b55c25eac48baebd131ded9d4f" title="Tries to send a message to the other end of this connection. ">sendMessage</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__InterprocessConnection_8h.html">juce_InterprocessConnection.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|