/usr/share/doc/libservlet3.1-java/api/javax/websocket/WebSocketContainer.html is in libservlet3.1-java-doc 8.0.14-1+deb8u11.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.7.0_151) on Fri Sep 15 15:03:18 UTC 2017 -->
<title>WebSocketContainer (Tomcat API Documentation)</title>
<meta name="date" content="2017-09-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WebSocketContainer (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/websocket/SessionException.html" title="class in javax.websocket"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/websocket/WebSocketContainer.html" target="_top">Frames</a></li>
<li><a href="WebSocketContainer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.websocket</div>
<h2 title="Interface WebSocketContainer" class="title">Interface WebSocketContainer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../javax/websocket/server/ServerContainer.html" title="interface in javax.websocket.server">ServerContainer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">WebSocketContainer</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#connectToServer(java.lang.Class,%20java.net.URI)">connectToServer</a></strong>(java.lang.Class<?> annotatedEndpointClass,
java.net.URI path)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#connectToServer(java.lang.Class,%20javax.websocket.ClientEndpointConfig,%20java.net.URI)">connectToServer</a></strong>(java.lang.Class<? extends <a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a>> endpoint,
<a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> clientEndpointConfiguration,
java.net.URI path)</code>
<div class="block">Creates a new connection to the WebSocket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#connectToServer(javax.websocket.Endpoint,%20javax.websocket.ClientEndpointConfig,%20java.net.URI)">connectToServer</a></strong>(<a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a> endpoint,
<a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> clientEndpointConfiguration,
java.net.URI path)</code>
<div class="block">Creates a new connection to the WebSocket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#connectToServer(java.lang.Object,%20java.net.URI)">connectToServer</a></strong>(java.lang.Object endpoint,
java.net.URI path)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#getDefaultAsyncSendTimeout()">getDefaultAsyncSendTimeout</a></strong>()</code>
<div class="block">Obtain the default timeout (in milliseconds) for sending a message
asynchronously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxBinaryMessageBufferSize()">getDefaultMaxBinaryMessageBufferSize</a></strong>()</code>
<div class="block">Get the default maximum buffer size (in bytes) for binary messages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxSessionIdleTimeout()">getDefaultMaxSessionIdleTimeout</a></strong>()</code>
<div class="block">Get the current default session idle timeout in milliseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxTextMessageBufferSize()">getDefaultMaxTextMessageBufferSize</a></strong>()</code>
<div class="block">Get the default maximum buffer size (in characters) for text messages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>></code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#getInstalledExtensions()">getInstalledExtensions</a></strong>()</code>
<div class="block">Get the set of extensions that are supported by this WebSocket
implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#setAsyncSendTimeout(long)">setAsyncSendTimeout</a></strong>(long timeout)</code>
<div class="block">Set the default timeout (in milliseconds) for sending a message
asynchronously.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxBinaryMessageBufferSize(int)">setDefaultMaxBinaryMessageBufferSize</a></strong>(int max)</code>
<div class="block">Set the default maximum buffer size (in bytes) for binary messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxSessionIdleTimeout(long)">setDefaultMaxSessionIdleTimeout</a></strong>(long timeout)</code>
<div class="block">Set the current default session idle timeout in milliseconds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxTextMessageBufferSize(int)">setDefaultMaxTextMessageBufferSize</a></strong>(int max)</code>
<div class="block">Set the default maximum buffer size (in characters) for text messages.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDefaultAsyncSendTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultAsyncSendTimeout</h4>
<pre>long getDefaultAsyncSendTimeout()</pre>
<div class="block">Obtain the default timeout (in milliseconds) for sending a message
asynchronously. A non-positive value means an infinite timeout.</div>
</li>
</ul>
<a name="setAsyncSendTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsyncSendTimeout</h4>
<pre>void setAsyncSendTimeout(long timeout)</pre>
<div class="block">Set the default timeout (in milliseconds) for sending a message
asynchronously. A non-positive value means an infinite timeout.</div>
</li>
</ul>
<a name="connectToServer(java.lang.Object, java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToServer</h4>
<pre><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a> connectToServer(java.lang.Object endpoint,
java.net.URI path)
throws <a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a>,
java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="connectToServer(java.lang.Class, java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToServer</h4>
<pre><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a> connectToServer(java.lang.Class<?> annotatedEndpointClass,
java.net.URI path)
throws <a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a>,
java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="connectToServer(javax.websocket.Endpoint, javax.websocket.ClientEndpointConfig, java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToServer</h4>
<pre><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a> connectToServer(<a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a> endpoint,
<a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> clientEndpointConfiguration,
java.net.URI path)
throws <a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a>,
java.io.IOException</pre>
<div class="block">Creates a new connection to the WebSocket.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - The endpoint instance that will handle responses from the
server</dd><dd><code>clientEndpointConfiguration</code> - Used to configure the new connection</dd><dd><code>path</code> - The full URL of the WebSocket endpoint to connect to</dd>
<dt><span class="strong">Returns:</span></dt><dd>The WebSocket session for the connection</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - If the connection can not be established</dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="connectToServer(java.lang.Class, javax.websocket.ClientEndpointConfig, java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToServer</h4>
<pre><a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a> connectToServer(java.lang.Class<? extends <a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a>> endpoint,
<a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> clientEndpointConfiguration,
java.net.URI path)
throws <a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a>,
java.io.IOException</pre>
<div class="block">Creates a new connection to the WebSocket.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - An instance of this class will be created to handle responses
from the server</dd><dd><code>clientEndpointConfiguration</code> - Used to configure the new connection</dd><dd><code>path</code> - The full URL of the WebSocket endpoint to connect to</dd>
<dt><span class="strong">Returns:</span></dt><dd>The WebSocket session for the connection</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - If the connection can not be established</dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getDefaultMaxSessionIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMaxSessionIdleTimeout</h4>
<pre>long getDefaultMaxSessionIdleTimeout()</pre>
<div class="block">Get the current default session idle timeout in milliseconds. Zero or
negative values indicate an infinite timeout.</div>
</li>
</ul>
<a name="setDefaultMaxSessionIdleTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultMaxSessionIdleTimeout</h4>
<pre>void setDefaultMaxSessionIdleTimeout(long timeout)</pre>
<div class="block">Set the current default session idle timeout in milliseconds. Zero or
negative values indicate an infinite timeout.</div>
</li>
</ul>
<a name="getDefaultMaxBinaryMessageBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMaxBinaryMessageBufferSize</h4>
<pre>int getDefaultMaxBinaryMessageBufferSize()</pre>
<div class="block">Get the default maximum buffer size (in bytes) for binary messages.</div>
</li>
</ul>
<a name="setDefaultMaxBinaryMessageBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultMaxBinaryMessageBufferSize</h4>
<pre>void setDefaultMaxBinaryMessageBufferSize(int max)</pre>
<div class="block">Set the default maximum buffer size (in bytes) for binary messages.</div>
</li>
</ul>
<a name="getDefaultMaxTextMessageBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMaxTextMessageBufferSize</h4>
<pre>int getDefaultMaxTextMessageBufferSize()</pre>
<div class="block">Get the default maximum buffer size (in characters) for text messages.</div>
</li>
</ul>
<a name="setDefaultMaxTextMessageBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultMaxTextMessageBufferSize</h4>
<pre>void setDefaultMaxTextMessageBufferSize(int max)</pre>
<div class="block">Set the default maximum buffer size (in characters) for text messages.</div>
</li>
</ul>
<a name="getInstalledExtensions()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstalledExtensions</h4>
<pre>java.util.Set<<a href="../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>> getInstalledExtensions()</pre>
<div class="block">Get the set of extensions that are supported by this WebSocket
implementation.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/websocket/SessionException.html" title="class in javax.websocket"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/websocket/WebSocketContainer.html" target="_top">Frames</a></li>
<li><a href="WebSocketContainer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2000-2014 The Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|