| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Feb 22 09:41:51 CST 2021 --> |
| <title>JettyWebSocketServerContainer (Eclipse Jetty API Doc - v10.0.1)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-22"> |
| <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="JettyWebSocketServerContainer (Eclipse Jetty API Doc - v10.0.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| 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/JettyWebSocketServerContainer.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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.server</a></div> |
| <h2 title="Class JettyWebSocketServerContainer" class="title">Class JettyWebSocketServerContainer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.server.JettyWebSocketServerContainer</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.util.EventListener</code>, <code><a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code>, <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code>, <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code>, <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">JettyWebSocketServerContainer</span> |
| extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a>, <a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>, <a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_WEBSOCKET_CONTAINER_ATTRIBUTE">JETTY_WEBSOCKET_CONTAINER_ATTRIBUTE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.html#KEY">KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="#addMapping(java.lang.String,java.lang.Class)">addMapping</a></span>​(java.lang.String pathSpec, |
| java.lang.Class<?> endpointClass)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(java.lang.String,org.eclipse.jetty.websocket.server.JettyWebSocketCreator)">addMapping</a></span>​(java.lang.String pathSpec, |
| <a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a> creator)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" 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.api.WebSocketSessionListener)">addSessionListener</a></span>​(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Register a WebSocketSessionListener with the container</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="JettyWebSocketServerContainer.html" title="class in org.eclipse.jetty.websocket.server">JettyWebSocketServerContainer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ensureContainer(javax.servlet.ServletContext)">ensureContainer</a></span>​(javax.servlet.ServletContext servletContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBehavior()">getBehavior</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="JettyWebSocketServerContainer.html" title="class in org.eclipse.jetty.websocket.server">JettyWebSocketServerContainer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainer(javax.servlet.ServletContext)">getContainer</a></span>​(javax.servlet.ServletContext servletContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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">The Container provided Executor.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.time.Duration</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdleTimeout()">getIdleTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInputBufferSize()">getInputBufferSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The input (read from network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the maximum size of a binary message during parsing.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxFrameSize()">getMaxFrameSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxTextMessageSize()">getMaxTextMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the maximum size of a text message during parsing.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenSessions()">getOpenSessions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the collection of open Sessions being tracked by this container</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutputBufferSize()">getOutputBufferSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The output (write to network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAutoFragment()">isAutoFragment</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If true, frames are automatically fragmented to respect the maximum frame size.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifySessionListeners(java.util.function.Consumer)">notifySessionListeners</a></span>​(java.util.function.Consumer<<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a>> consumer)</code></th> |
| <td class="colLast"> |
| <div class="block">Notify the Session Listeners of an event.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)">removeSessionListener</a></span>​(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a WebSocketSessionListener from the container</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAutoFragment(boolean)">setAutoFragment</a></span>​(boolean autoFragment)</code></th> |
| <td class="colLast"> |
| <div class="block">If set to true, frames are automatically fragmented to respect the maximum frame size.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdleTimeout(java.time.Duration)">setIdleTimeout</a></span>​(java.time.Duration duration)</code></th> |
| <td class="colLast"> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInputBufferSize(int)">setInputBufferSize</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block">The input (read from network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a></span>​(long size)</code></th> |
| <td class="colLast"> |
| <div class="block">The maximum size of a binary message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxFrameSize(long)">setMaxFrameSize</a></span>​(long maxFrameSize)</code></th> |
| <td class="colLast"> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxTextMessageSize(long)">setMaxTextMessageSize</a></span>​(long size)</code></th> |
| <td class="colLast"> |
| <div class="block">The maximum size of a text message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutputBufferSize(int)">setOutputBufferSize</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block">The output (write to network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upgrade(org.eclipse.jetty.websocket.server.JettyWebSocketCreator,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">upgrade</a></span>​(<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a> creator, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code></th> |
| <td class="colLast"> |
| <div class="block">An immediate programmatic WebSocket upgrade that does not register a mapping or create a <a href="../servlet/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.servlet"><code>WebSocketUpgradeFilter</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addEventListener(java.util.EventListener)">addEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../util/component/ContainerLifeCycle.html#destroy()">destroy</a>, <a href="../../util/component/ContainerLifeCycle.html#doStart()">doStart</a>, <a href="../../util/component/ContainerLifeCycle.html#doStop()">doStop</a>, <a href="../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#getEventListeners()">getEventListeners</a>, <a href="../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/AbstractLifeCycle.html#setEventListeners(java.util.Collection)">setEventListeners</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a>, <a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../util/component/Container.html#getCachedBeans(java.lang.Class)">getCachedBeans</a>, <a href="../../util/component/Container.html#getEventListeners()">getEventListeners</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable.DumpableContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle.Listener"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></h3> |
| <code><a href="../../util/component/LifeCycle.Listener.html#lifeCycleFailure(org.eclipse.jetty.util.component.LifeCycle,java.lang.Throwable)">lifeCycleFailure</a>, <a href="../../util/component/LifeCycle.Listener.html#lifeCycleStarted(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStarted</a>, <a href="../../util/component/LifeCycle.Listener.html#lifeCycleStarting(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStarting</a>, <a href="../../util/component/LifeCycle.Listener.html#lifeCycleStopped(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStopped</a>, <a href="../../util/component/LifeCycle.Listener.html#lifeCycleStopping(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStopping</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="JETTY_WEBSOCKET_CONTAINER_ATTRIBUTE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JETTY_WEBSOCKET_CONTAINER_ATTRIBUTE</h4> |
| <pre>public static final java.lang.String JETTY_WEBSOCKET_CONTAINER_ATTRIBUTE</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getContainer(javax.servlet.ServletContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainer</h4> |
| <pre class="methodSignature">public static <a href="JettyWebSocketServerContainer.html" title="class in org.eclipse.jetty.websocket.server">JettyWebSocketServerContainer</a> getContainer​(javax.servlet.ServletContext servletContext)</pre> |
| </li> |
| </ul> |
| <a id="ensureContainer(javax.servlet.ServletContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureContainer</h4> |
| <pre class="methodSignature">public static <a href="JettyWebSocketServerContainer.html" title="class in org.eclipse.jetty.websocket.server">JettyWebSocketServerContainer</a> ensureContainer​(javax.servlet.ServletContext servletContext)</pre> |
| </li> |
| </ul> |
| <a id="addMapping(java.lang.String,org.eclipse.jetty.websocket.server.JettyWebSocketCreator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(java.lang.String pathSpec, |
| <a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a> creator)</pre> |
| </li> |
| </ul> |
| <a id="addMapping(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(java.lang.String pathSpec, |
| java.lang.Class<?> endpointClass)</pre> |
| </li> |
| </ul> |
| <a id="upgrade(org.eclipse.jetty.websocket.server.JettyWebSocketCreator,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>upgrade</h4> |
| <pre class="methodSignature">public boolean upgrade​(<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a> creator, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException</pre> |
| <div class="block">An immediate programmatic WebSocket upgrade that does not register a mapping or create a <a href="../servlet/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.servlet"><code>WebSocketUpgradeFilter</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>creator</code> - the WebSocketCreator to use.</dd> |
| <dd><code>request</code> - the HttpServletRequest.</dd> |
| <dd><code>response</code> - the HttpServletResponse.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the connection was successfully upgraded to WebSocket.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an I/O error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExecutor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutor</h4> |
| <pre class="methodSignature">public java.util.concurrent.Executor getExecutor()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketContainer.html#getExecutor()">WebSocketContainer</a></code></span></div> |
| <div class="block">The Container provided Executor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketContainer.html#getExecutor()">getExecutor</a></code> in interface <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSessionListener</h4> |
| <pre class="methodSignature">public void addSessionListener​(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketContainer.html#addSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)">WebSocketContainer</a></code></span></div> |
| <div class="block">Register a WebSocketSessionListener with the container</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketContainer.html#addSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)">addSessionListener</a></code> in interface <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSessionListener</h4> |
| <pre class="methodSignature">public boolean removeSessionListener​(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketContainer.html#removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)">WebSocketContainer</a></code></span></div> |
| <div class="block">Remove a WebSocketSessionListener from the container</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketContainer.html#removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)">removeSessionListener</a></code> in interface <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if listener was present and removed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="notifySessionListeners(java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifySessionListeners</h4> |
| <pre class="methodSignature">public void notifySessionListeners​(java.util.function.Consumer<<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a>> consumer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketContainer.html#notifySessionListeners(java.util.function.Consumer)">WebSocketContainer</a></code></span></div> |
| <div class="block">Notify the Session Listeners of an event.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketContainer.html#notifySessionListeners(java.util.function.Consumer)">notifySessionListeners</a></code> in interface <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - the consumer to call for each tracked listener</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOpenSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenSessions</h4> |
| <pre class="methodSignature">public java.util.Collection<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> getOpenSessions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketContainer.html#getOpenSessions()">WebSocketContainer</a></code></span></div> |
| <div class="block">Get the collection of open Sessions being tracked by this container</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketContainer.html#getOpenSessions()">getOpenSessions</a></code> in interface <code><a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the collection of open sessions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBehavior()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBehavior</h4> |
| <pre class="methodSignature">public <a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a> getBehavior()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getBehavior()">getBehavior</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre class="methodSignature">public java.time.Duration getIdleTimeout()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getIdleTimeout()">WebSocketPolicy</a></code></span></div> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getIdleTimeout()">getIdleTimeout</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeout duration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInputBufferSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputBufferSize</h4> |
| <pre class="methodSignature">public int getInputBufferSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getInputBufferSize()">WebSocketPolicy</a></code></span></div> |
| <div class="block">The input (read from network layer) buffer size. |
| <p> |
| This is the raw read operation buffer size, before the parsing of the websocket frames. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getInputBufferSize()">getInputBufferSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the raw network buffer input size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOutputBufferSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputBufferSize</h4> |
| <pre class="methodSignature">public int getOutputBufferSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getOutputBufferSize()">WebSocketPolicy</a></code></span></div> |
| <div class="block">The output (write to network layer) buffer size. |
| <p> |
| This is the raw write operation buffer size and has no relationship to the websocket frame. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getOutputBufferSize()">getOutputBufferSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the raw network buffer output size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxBinaryMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxBinaryMessageSize</h4> |
| <pre class="methodSignature">public long getMaxBinaryMessageSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getMaxBinaryMessageSize()">WebSocketPolicy</a></code></span></div> |
| <div class="block">Get the maximum size of a binary message during parsing. |
| <p> |
| This is a memory conservation option, memory over this limit will not be |
| allocated by Jetty for handling binary messages. This applies to individual frames, |
| whole message handling, and partial message handling. |
| </p> |
| <p> |
| Binary messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a> |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a binary message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxTextMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxTextMessageSize</h4> |
| <pre class="methodSignature">public long getMaxTextMessageSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getMaxTextMessageSize()">WebSocketPolicy</a></code></span></div> |
| <div class="block">Get the maximum size of a text message during parsing. |
| <p> |
| This is a memory conservation option, memory over this limit will not be |
| allocated by Jetty for handling text messages. This applies to individual frames, |
| whole message handling, and partial message handling. |
| </p> |
| <p> |
| Text messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a> |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getMaxTextMessageSize()">getMaxTextMessageSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a text message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxFrameSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFrameSize</h4> |
| <pre class="methodSignature">public long getMaxFrameSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#getMaxFrameSize()">WebSocketPolicy</a></code></span></div> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#getMaxFrameSize()">getMaxFrameSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a WebSocket Frame.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAutoFragment()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAutoFragment</h4> |
| <pre class="methodSignature">public boolean isAutoFragment()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#isAutoFragment()">WebSocketPolicy</a></code></span></div> |
| <div class="block">If true, frames are automatically fragmented to respect the maximum frame size.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#isAutoFragment()">isAutoFragment</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to automatically fragment incoming WebSocket Frames.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIdleTimeout(java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdleTimeout</h4> |
| <pre class="methodSignature">public void setIdleTimeout​(java.time.Duration duration)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the timeout duration (may not be null or negative)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setInputBufferSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInputBufferSize</h4> |
| <pre class="methodSignature">public void setInputBufferSize​(int size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setInputBufferSize(int)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The input (read from network layer) buffer size.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setInputBufferSize(int)">setInputBufferSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOutputBufferSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputBufferSize</h4> |
| <pre class="methodSignature">public void setOutputBufferSize​(int size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setOutputBufferSize(int)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The output (write to network layer) buffer size.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setOutputBufferSize(int)">setOutputBufferSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxBinaryMessageSize(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxBinaryMessageSize</h4> |
| <pre class="methodSignature">public void setMaxBinaryMessageSize​(long size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setMaxBinaryMessageSize(long)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The maximum size of a binary message during parsing/generating. |
| <p> |
| Binary messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a> |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the maximum allowed size of a binary message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxTextMessageSize(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxTextMessageSize</h4> |
| <pre class="methodSignature">public void setMaxTextMessageSize​(long size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setMaxTextMessageSize(long)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The maximum size of a text message during parsing/generating. |
| <p> |
| Text messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the maximum allowed size of a text message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxFrameSize(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxFrameSize</h4> |
| <pre class="methodSignature">public void setMaxFrameSize​(long maxFrameSize)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setMaxFrameSize(long)">WebSocketPolicy</a></code></span></div> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received. |
| <p> |
| WebSocket Frames over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a> |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setMaxFrameSize(long)">setMaxFrameSize</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxFrameSize</code> - the maximum allowed size of a WebSocket Frame.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAutoFragment(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setAutoFragment</h4> |
| <pre class="methodSignature">public void setAutoFragment​(boolean autoFragment)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/WebSocketPolicy.html#setAutoFragment(boolean)">WebSocketPolicy</a></code></span></div> |
| <div class="block">If set to true, frames are automatically fragmented to respect the maximum frame size.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/WebSocketPolicy.html#setAutoFragment(boolean)">setAutoFragment</a></code> in interface <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>autoFragment</code> - whether to automatically fragment incoming WebSocket Frames.</dd> |
| </dl> |
| </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/JettyWebSocketServerContainer.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |