| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Fri Oct 01 11:33:56 CDT 2021 --> |
| <title>WebSocketContainerScope (Jetty :: Project 9.4.44.v20210927 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-10-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebSocketContainerScope (Jetty :: Project 9.4.44.v20210927 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketContainerScope.html">Use</a></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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.common.scopes</a></div> |
| <h2 title="Interface WebSocketContainerScope" class="title">Interface WebSocketContainerScope</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../jsr356/ClientContainer.html" title="class in org.eclipse.jetty.websocket.jsr356">ClientContainer</a></code>, <code><a href="DelegatedContainerScope.html" title="class in org.eclipse.jetty.websocket.common.scopes">DelegatedContainerScope</a></code>, <code><a href="../../jsr356/server/ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a></code>, <code><a href="SimpleContainerScope.html" title="class in org.eclipse.jetty.websocket.common.scopes">SimpleContainerScope</a></code>, <code><a href="../../client/WebSocketClient.html" title="class in org.eclipse.jetty.websocket.client">WebSocketClient</a></code>, <code><a href="../../server/WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">WebSocketContainerScope</span></pre> |
| <div class="block">Defined Scope for a WebSocketContainer.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">addSessionListener</a></span>​(<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The configured Container Buffer Pool.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default java.lang.ClassLoader</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassLoader()">getClassLoader</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The ClassLoader used to load classes for the WebSocketSession.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Executor</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Executor in use by the container.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectFactory()">getObjectFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Object Factory used to create objects.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The policy the container is running on.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionListeners()">getSessionListeners</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslContextFactory()">getSslContextFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The SslContextFactory in use by the container.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRunning()">isRunning</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Test for if the container has been started.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">removeSessionListener</a></span>​(<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getBufferPool()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferPool</h4> |
| <pre class="methodSignature"><a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> getBufferPool()</pre> |
| <div class="block">The configured Container Buffer Pool.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the buffer pool (never null)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExecutor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutor</h4> |
| <pre class="methodSignature">java.util.concurrent.Executor getExecutor()</pre> |
| <div class="block">Executor in use by the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Executor in use by the container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getObjectFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectFactory</h4> |
| <pre class="methodSignature"><a href="../../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a> getObjectFactory()</pre> |
| <div class="block">Object Factory used to create objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object Factory used to create instances of objects.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre class="methodSignature"><a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block">The policy the container is running on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the websocket policy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSslContextFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslContextFactory</h4> |
| <pre class="methodSignature"><a href="../../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> getSslContextFactory()</pre> |
| <div class="block">The SslContextFactory in use by the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SslContextFactory in use by the container (can be null if no SSL context is defined)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClassLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassLoader</h4> |
| <pre class="methodSignature">default java.lang.ClassLoader getClassLoader()</pre> |
| <div class="block"><p>The ClassLoader used to load classes for the WebSocketSession.</p> |
| <p>By default this will be the ContextClassLoader at the time this method is called. However this will be overridden |
| by the WebSocketClient to use the ContextClassLoader at the time it was created, this is because the |
| client uses its own <a href="../../../util/thread/ThreadPool.html" title="interface in org.eclipse.jetty.util.thread"><code>ThreadPool</code></a> so the WebSocketSessions may be created when |
| the ContextClassLoader is not set.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the classloader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRunning()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRunning</h4> |
| <pre class="methodSignature">boolean isRunning()</pre> |
| <div class="block">Test for if the container has been started.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if container is started and running</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSessionListener</h4> |
| <pre class="methodSignature">void addSessionListener​(<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</pre> |
| </li> |
| </ul> |
| <a id="removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSessionListener</h4> |
| <pre class="methodSignature">void removeSessionListener​(<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</pre> |
| </li> |
| </ul> |
| <a id="getSessionListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSessionListeners</h4> |
| <pre class="methodSignature">java.util.Collection<<a href="../WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>> getSessionListeners()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketContainerScope.html">Use</a></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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
