| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WebSocketContainer</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebSocketContainer"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="typeNameLink">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="typeNameLabel">WebSocketContainer</span></pre> |
| <div class="block">A WebSocketContainer is an implementation provided object that provides applications a view on the container running |
| it. The WebSocketContainer container various configuration parameters that control default session and buffer |
| properties of the endpoints it contains. It also allows the developer to deploy websocket client endpoints by |
| initiating a web socket handshake from the provided endpoint to a supplied URI where the peer endpoint is presumed to |
| reside. |
| |
| <p> |
| A WebSocketContainer may be accessed by concurrent threads, so implementations must ensure the integrity of its |
| mutable attributes in such circumstances.</div> |
| </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" 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><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#connectToServer-java.lang.Class-java.net.URI-">connectToServer</a></span>(java.lang.Class<?> annotatedEndpointClass, |
| java.net.URI path)</code> |
| <div class="block">Connect the supplied annotated endpoint to its server.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#connectToServer-java.lang.Class-javax.websocket.ClientEndpointConfig-java.net.URI-">connectToServer</a></span>(java.lang.Class<? extends <a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a>> endpointClass, |
| <a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> cec, |
| java.net.URI path)</code> |
| <div class="block">Connect the supplied programmatic endpoint to its server with the given configuration.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#connectToServer-javax.websocket.Endpoint-javax.websocket.ClientEndpointConfig-java.net.URI-">connectToServer</a></span>(<a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket">Endpoint</a> endpointInstance, |
| <a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> cec, |
| java.net.URI path)</code> |
| <div class="block">Connect the supplied programmatic client endpoint instance to its server with the given configuration.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#connectToServer-java.lang.Object-java.net.URI-">connectToServer</a></span>(java.lang.Object annotatedEndpointInstance, |
| java.net.URI path)</code> |
| <div class="block">Connect the supplied annotated endpoint instance to its server.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#getDefaultAsyncSendTimeout--">getDefaultAsyncSendTimeout</a></span>()</code> |
| <div class="block">Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all |
| RemoteEndpoints associated with this container.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxBinaryMessageBufferSize--">getDefaultMaxBinaryMessageBufferSize</a></span>()</code> |
| <div class="block">Returns the default maximum size of incoming binary message that this container will buffer.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxSessionIdleTimeout--">getDefaultMaxSessionIdleTimeout</a></span>()</code> |
| <div class="block">Return the default time in milliseconds after which any web socket sessions in this container will be closed if |
| it has been inactive.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#getDefaultMaxTextMessageBufferSize--">getDefaultMaxTextMessageBufferSize</a></span>()</code> |
| <div class="block">Returns the default maximum size of incoming text message that this container will buffer.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#getInstalledExtensions--">getInstalledExtensions</a></span>()</code> |
| <div class="block">Return the set of Extensions installed in the container.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#setAsyncSendTimeout-long-">setAsyncSendTimeout</a></span>(long timeoutmillis)</code> |
| <div class="block">Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all |
| RemoteEndpoints associated with this container.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxBinaryMessageBufferSize-int-">setDefaultMaxBinaryMessageBufferSize</a></span>(int max)</code> |
| <div class="block">Sets the default maximum size of incoming binary message that this container will buffer.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxSessionIdleTimeout-long-">setDefaultMaxSessionIdleTimeout</a></span>(long timeout)</code> |
| <div class="block">Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it |
| has been inactive.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/WebSocketContainer.html#setDefaultMaxTextMessageBufferSize-int-">setDefaultMaxTextMessageBufferSize</a></span>(int max)</code> |
| <div class="block">Sets the maximum size of incoming text message that this container will buffer.</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">Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all |
| RemoteEndpoints associated with this container. A non-positive number indicates the implementation will not |
| timeout attempting to send a websocket message asynchronously. Note this default may be overridden in each |
| RemoteEndpoint.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeout time in milliseconds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAsyncSendTimeout-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAsyncSendTimeout</h4> |
| <pre>void setAsyncSendTimeout(long timeoutmillis)</pre> |
| <div class="block">Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all |
| RemoteEndpoints associated with this container. A non-positive number indicates the implementation will not |
| timeout attempting to send a websocket message asynchronously. Note this default may be overridden in each |
| RemoteEndpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeoutmillis</code> - the timeout in milliseconds or a non-positive number for no timeout</dd> |
| </dl> |
| </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 annotatedEndpointInstance, |
| 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">Connect the supplied annotated endpoint instance to its server. The supplied object must be a class decorated |
| with the class level <code>javax.websocket.server.ServerEndpoint</code> annotation. This method blocks until the |
| connection is established, or throws an error if either the connection could not be made or there was a problem |
| with the supplied endpoint class. If the developer uses this method to deploy the client endpoint, services like |
| dependency injection that are supported, for example, when the implementation is part of the Java EE platform may |
| not be available. If the client endpoint uses dependency injection, use |
| <a href="../../javax/websocket/WebSocketContainer.html#connectToServer-java.lang.Class-java.net.URI-"><code>connectToServer(java.lang.Class, java.net.URI)</code></a> instead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>annotatedEndpointInstance</code> - the annotated websocket client endpoint instance.</dd> |
| <dd><code>path</code> - the complete path to the server endpoint.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Session created if the connection is successful.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - if the annotated endpoint instance is not valid.</dd> |
| <dd><code>java.io.IOException</code> - if there was a network or protocol problem that prevented the client endpoint being |
| connected to its server.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if called during the deployment phase of the containing application.</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> |
| <div class="block">Connect the supplied annotated endpoint to its server. The supplied object must be a class decorated with the |
| class level <code>javax.websocket.server.ServerEndpoint</code> annotation. This method blocks until the connection is |
| established, or throws an error if either the connection could not be made or there was a problem with the |
| supplied endpoint class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>annotatedEndpointClass</code> - the annotated websocket client endpoint.</dd> |
| <dd><code>path</code> - the complete path to the server endpoint.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Session created if the connection is successful.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - if the class is not a valid annotated endpoint class.</dd> |
| <dd><code>java.io.IOException</code> - if there was a network or protocol problem that prevented the client endpoint being |
| connected to its server.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if called during the deployment phase of the containing application.</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> endpointInstance, |
| <a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> cec, |
| 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">Connect the supplied programmatic client endpoint instance to its server with the given configuration. This |
| method blocks until the connection is established, or throws an error if the connection could not be made. If the |
| developer uses this method to deploy the client endpoint, services like dependency injection that are supported, |
| for example, when the implementation is part of the Java EE platform may not be available. If the client endpoint |
| uses dependency injection, use |
| <a href="../../javax/websocket/WebSocketContainer.html#connectToServer-java.lang.Class-javax.websocket.ClientEndpointConfig-java.net.URI-"><code>connectToServer(java.lang.Class, javax.websocket.ClientEndpointConfig, java.net.URI)</code></a> |
| instead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointInstance</code> - the programmatic client endpoint instance <a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket"><code>Endpoint</code></a>.</dd> |
| <dd><code>path</code> - the complete path to the server endpoint.</dd> |
| <dd><code>cec</code> - the configuration used to configure the programmatic endpoint.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Session created if the connection is successful.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - if the configuration is not valid</dd> |
| <dd><code>java.io.IOException</code> - if there was a network or protocol problem that prevented the client endpoint being |
| connected to its server</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if called during the deployment phase of the containing application.</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>> endpointClass, |
| <a href="../../javax/websocket/ClientEndpointConfig.html" title="interface in javax.websocket">ClientEndpointConfig</a> cec, |
| 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">Connect the supplied programmatic endpoint to its server with the given configuration. This method blocks until |
| the connection is established, or throws an error if the connection could not be made.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointClass</code> - the programmatic client endpoint class <a href="../../javax/websocket/Endpoint.html" title="class in javax.websocket"><code>Endpoint</code></a>.</dd> |
| <dd><code>path</code> - the complete path to the server endpoint.</dd> |
| <dd><code>cec</code> - the configuration used to configure the programmatic endpoint.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Session created if the connection is successful.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/websocket/DeploymentException.html" title="class in javax.websocket">DeploymentException</a></code> - if the configuration is not valid</dd> |
| <dd><code>java.io.IOException</code> - if there was a network or protocol problem that prevented the client endpoint being |
| connected to its server</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if called during the deployment phase of the containing application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultMaxSessionIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultMaxSessionIdleTimeout</h4> |
| <pre>long getDefaultMaxSessionIdleTimeout()</pre> |
| <div class="block">Return the default time in milliseconds after which any web socket sessions in this container will be closed if |
| it has been inactive. A value that is 0 or negative indicates the sessions will never timeout due to inactivity. |
| The value may be overridden on a per session basis using <a href="../../javax/websocket/Session.html#setMaxIdleTimeout-long-"><code>Session.setMaxIdleTimeout(long)</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default number of milliseconds after which an idle session in this container will be closed</dd> |
| </dl> |
| </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">Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it |
| has been inactive. A value that is 0 or negative indicates the sessions will never timeout due to inactivity. The |
| value may be overridden on a per session basis using <a href="../../javax/websocket/Session.html#setMaxIdleTimeout-long-"><code>Session.setMaxIdleTimeout(long)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the maximum time in milliseconds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultMaxBinaryMessageBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultMaxBinaryMessageBufferSize</h4> |
| <pre>int getDefaultMaxBinaryMessageBufferSize()</pre> |
| <div class="block">Returns the default maximum size of incoming binary message that this container will buffer. This default may be |
| overridden on a per session basis using <a href="../../javax/websocket/Session.html#setMaxBinaryMessageBufferSize-int-"><code>Session.setMaxBinaryMessageBufferSize(int)</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of incoming binary message in number of bytes.</dd> |
| </dl> |
| </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">Sets the default maximum size of incoming binary message that this container will buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>max</code> - the maximum size of binary message in number of bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultMaxTextMessageBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultMaxTextMessageBufferSize</h4> |
| <pre>int getDefaultMaxTextMessageBufferSize()</pre> |
| <div class="block">Returns the default maximum size of incoming text message that this container will buffer. This default may be |
| overridden on a per session basis using <a href="../../javax/websocket/Session.html#setMaxTextMessageBufferSize-int-"><code>Session.setMaxTextMessageBufferSize(int)</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of incoming text message in number of bytes.</dd> |
| </dl> |
| </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">Sets the maximum size of incoming text message that this container will buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>max</code> - the maximum size of text message in number of bytes.</dd> |
| </dl> |
| </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">Return the set of Extensions installed in the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the set of extensions.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="typeNameLink">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 ======= --> |
| </body> |
| </html> |