/usr/share/doc/libjuce/apiref/classInterprocessConnectionServer.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 | <!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: InterprocessConnectionServer 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="#pro-methods">Protected Member Functions</a> |
<a href="classInterprocessConnectionServer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">InterprocessConnectionServer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An object that waits for client sockets to connect to a port on this host, and creates <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> objects for each one.
<a href="classInterprocessConnectionServer.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for InterprocessConnectionServer:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classInterprocessConnectionServer.png" usemap="#InterprocessConnectionServer_map" alt=""/>
<map id="InterprocessConnectionServer_map" name="InterprocessConnectionServer_map">
<area href="classThread.html" title="Encapsulates a thread. " alt="Thread" shape="rect" coords="0,0,185,24"/>
</map>
</div></div>
<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:af1449e1e8da7ad7a7a30a15e3edea59f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnectionServer.html#af1449e1e8da7ad7a7a30a15e3edea59f">InterprocessConnectionServer</a> ()</td></tr>
<tr class="memdesc:af1449e1e8da7ad7a7a30a15e3edea59f"><td class="mdescLeft"> </td><td class="mdescRight">Creates an uninitialised server object. <a href="#af1449e1e8da7ad7a7a30a15e3edea59f">More...</a><br /></td></tr>
<tr class="separator:af1449e1e8da7ad7a7a30a15e3edea59f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5a60a85820e4c6344a2225b81cf630d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnectionServer.html#ac5a60a85820e4c6344a2225b81cf630d">~InterprocessConnectionServer</a> ()</td></tr>
<tr class="memdesc:ac5a60a85820e4c6344a2225b81cf630d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac5a60a85820e4c6344a2225b81cf630d">More...</a><br /></td></tr>
<tr class="separator:ac5a60a85820e4c6344a2225b81cf630d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f4fb097909c5baeaf1646d88a54c695"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnectionServer.html#a2f4fb097909c5baeaf1646d88a54c695">beginWaitingForSocket</a> (int portNumber, const <a class="el" href="classString.html">String</a> &bindAddress=<a class="el" href="classString.html">String</a>())</td></tr>
<tr class="memdesc:a2f4fb097909c5baeaf1646d88a54c695"><td class="mdescLeft"> </td><td class="mdescRight">Starts an internal thread which listens on the given port number. <a href="#a2f4fb097909c5baeaf1646d88a54c695">More...</a><br /></td></tr>
<tr class="separator:a2f4fb097909c5baeaf1646d88a54c695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8a4c37b9e77848e48b499f441749324"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnectionServer.html#ac8a4c37b9e77848e48b499f441749324">stop</a> ()</td></tr>
<tr class="memdesc:ac8a4c37b9e77848e48b499f441749324"><td class="mdescLeft"> </td><td class="mdescRight">Terminates the listener thread, if it's active. <a href="#ac8a4c37b9e77848e48b499f441749324">More...</a><br /></td></tr>
<tr class="separator:ac8a4c37b9e77848e48b499f441749324"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af0f9bee85542b7adc149270ad779b415"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classInterprocessConnection.html">InterprocessConnection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterprocessConnectionServer.html#af0f9bee85542b7adc149270ad779b415">createConnectionObject</a> ()=0</td></tr>
<tr class="memdesc:af0f9bee85542b7adc149270ad779b415"><td class="mdescLeft"> </td><td class="mdescRight">Creates a suitable connection object for a client process that wants to connect to this one. <a href="#af0f9bee85542b7adc149270ad779b415">More...</a><br /></td></tr>
<tr class="separator:af0f9bee85542b7adc149270ad779b415"><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 object that waits for client sockets to connect to a port on this host, and creates <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> objects for each one. </p>
<p>To use this, create a class derived from it which implements the <a class="el" href="classInterprocessConnectionServer.html#af0f9bee85542b7adc149270ad779b415" title="Creates a suitable connection object for a client process that wants to connect to this one...">createConnectionObject()</a> method, so that it creates suitable connection objects for each client that tries to connect.</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="af1449e1e8da7ad7a7a30a15e3edea59f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1449e1e8da7ad7a7a30a15e3edea59f">§ </a></span>InterprocessConnectionServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InterprocessConnectionServer::InterprocessConnectionServer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an uninitialised server object. </p>
</div>
</div>
<a id="ac5a60a85820e4c6344a2225b81cf630d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5a60a85820e4c6344a2225b81cf630d">§ </a></span>~InterprocessConnectionServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InterprocessConnectionServer::~InterprocessConnectionServer </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="a2f4fb097909c5baeaf1646d88a54c695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f4fb097909c5baeaf1646d88a54c695">§ </a></span>beginWaitingForSocket()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterprocessConnectionServer::beginWaitingForSocket </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">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>bindAddress</em> = <code><a class="el" href="classString.html">String</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an internal thread which listens on the given port number. </p>
<p>While this is running, in another process tries to connect with the <a class="el" href="classInterprocessConnection.html#a007450a6ca6dc60bb48d384479d9a49d" title="Tries to connect this object to a socket. ">InterprocessConnection::connectToSocket()</a> method, this object will call <a class="el" href="classInterprocessConnectionServer.html#af0f9bee85542b7adc149270ad779b415" title="Creates a suitable connection object for a client process that wants to connect to this one...">createConnectionObject()</a> to create a connection to that client.</p>
<p>Use <a class="el" href="classInterprocessConnectionServer.html#ac8a4c37b9e77848e48b499f441749324" title="Terminates the listener thread, if it's active. ">stop()</a> to stop the thread running.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">portNumber</td><td>The port on which the server will receive connections </td></tr>
<tr><td class="paramname">bindAddress</td><td>The address on which the server will listen for connections. An empty string indicates that it should listen on all addresses assigned to this machine.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnectionServer.html#af0f9bee85542b7adc149270ad779b415" title="Creates a suitable connection object for a client process that wants to connect to this one...">createConnectionObject</a>, <a class="el" href="classInterprocessConnectionServer.html#ac8a4c37b9e77848e48b499f441749324" title="Terminates the listener thread, if it's active. ">stop</a> </dd></dl>
</div>
</div>
<a id="ac8a4c37b9e77848e48b499f441749324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8a4c37b9e77848e48b499f441749324">§ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void InterprocessConnectionServer::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates the listener thread, if it's active. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInterprocessConnectionServer.html#a2f4fb097909c5baeaf1646d88a54c695" title="Starts an internal thread which listens on the given port number. ">beginWaitingForSocket</a> </dd></dl>
</div>
</div>
<a id="af0f9bee85542b7adc149270ad779b415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0f9bee85542b7adc149270ad779b415">§ </a></span>createConnectionObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classInterprocessConnection.html">InterprocessConnection</a>* InterprocessConnectionServer::createConnectionObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a suitable connection object for a client process that wants to connect to this one. </p>
<p>This will be called by the listener thread when a client process tries to connect, and must return a new <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 that will then run as this end of the connection.</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>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__InterprocessConnectionServer_8h.html">juce_InterprocessConnectionServer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|