| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>WebSocketClient (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.websocket.client, class: WebSocketClient"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/WebSocketClient.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.client</a></div> |
| <h1 title="Class WebSocketClient" class="title">Class WebSocketClient</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a> |
| <div class="inheritance">org.eclipse.jetty.websocket.client.WebSocketClient</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><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="../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> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">WebSocketClient</span> |
| <span class="extends-implements">extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>, <a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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></h2> |
| <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></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Container">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></h2> |
| <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></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></h2> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.LifeCycle">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></h2> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">WebSocketClient</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Instantiate a WebSocketClient with defaults</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)" class="member-name-link">WebSocketClient</a><wbr>(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Instantiate a WebSocketClient using HttpClient for defaults</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)" class="member-name-link">addSessionListener</a><wbr>(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Register a WebSocketSessionListener with the container</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connect(java.lang.Object,java.net.URI)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to remote websocket endpoint</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest,org.eclipse.jetty.websocket.client.JettyUpgradeListener)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request, |
| <a href="JettyUpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client">JettyUpgradeListener</a> upgradeListener)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Connect to remote websocket endpoint</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doStop()" class="member-name-link">doStop</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dump(java.lang.Appendable,java.lang.String)" class="member-name-link">dump</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> out, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> indent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBehavior()" class="member-name-link">getBehavior</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBindAddress()" class="member-name-link">getBindAddress</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferPool()" class="member-name-link">getBufferPool</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConnectTimeout()" class="member-name-link">getConnectTimeout</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/CookieStore.html" title="class or interface in java.net" class="external-link">CookieStore</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCookieStore()" class="member-name-link">getCookieStore</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExecutor()" class="member-name-link">getExecutor</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The Container provided Executor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHttpClient()" class="member-name-link">getHttpClient</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIdleTimeout()" class="member-name-link">getIdleTimeout</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInputBufferSize()" class="member-name-link">getInputBufferSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The input (read from network layer) buffer size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxBinaryMessageSize()" class="member-name-link">getMaxBinaryMessageSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the maximum size of a binary message during parsing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxFrameSize()" class="member-name-link">getMaxFrameSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxTextMessageSize()" class="member-name-link">getMaxTextMessageSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the maximum size of a text message during parsing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectFactory()" class="member-name-link">getObjectFactory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpenSessions()" class="member-name-link">getOpenSessions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the collection of open Sessions being tracked by this container</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOutputBufferSize()" class="member-name-link">getOutputBufferSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The output (write to network layer) buffer size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSslContextFactory()" class="member-name-link">getSslContextFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStopTimeout()" class="member-name-link">getStopTimeout</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAutoFragment()" class="member-name-link">isAutoFragment</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If true, frames are automatically fragmented to respect the maximum frame size.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStopAtShutdown()" class="member-name-link">isStopAtShutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#notifySessionListeners(java.util.function.Consumer)" class="member-name-link">notifySessionListeners</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a>> consumer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Notify the Session Listeners of an event.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)" class="member-name-link">removeSessionListener</a><wbr>(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove a WebSocketSessionListener from the container</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAutoFragment(boolean)" class="member-name-link">setAutoFragment</a><wbr>(boolean autoFragment)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If set to true, frames are automatically fragmented to respect the maximum frame size.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBindAddress(java.net.SocketAddress)" class="member-name-link">setBindAddress</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> bindAddress)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConnectTimeout(long)" class="member-name-link">setConnectTimeout</a><wbr>(long ms)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the timeout for connecting to the remote server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCookieStore(java.net.CookieStore)" class="member-name-link">setCookieStore</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/CookieStore.html" title="class or interface in java.net" class="external-link">CookieStore</a> cookieStore)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIdleTimeout(java.time.Duration)" class="member-name-link">setIdleTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> duration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The duration that a websocket may be idle before being closed by the implementation</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInputBufferSize(int)" class="member-name-link">setInputBufferSize</a><wbr>(int size)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The input (read from network layer) buffer size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxBinaryMessageSize(long)" class="member-name-link">setMaxBinaryMessageSize</a><wbr>(long size)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The maximum size of a binary message during parsing/generating.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxFrameSize(long)" class="member-name-link">setMaxFrameSize</a><wbr>(long maxFrameSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The maximum payload size of any WebSocket Frame which can be received.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxTextMessageSize(long)" class="member-name-link">setMaxTextMessageSize</a><wbr>(long size)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The maximum size of a text message during parsing/generating.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOutputBufferSize(int)" class="member-name-link">setOutputBufferSize</a><wbr>(int size)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The output (write to network layer) buffer size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStopAtShutdown(boolean)" class="member-name-link">setStopAtShutdown</a><wbr>(boolean stop)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set JVM shutdown behavior.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStopTimeout(long)" class="member-name-link">setStopTimeout</a><wbr>(long stopTimeout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The timeout to allow all remaining open Sessions to be closed gracefully using the close code <a href="../api/StatusCode.html#SHUTDOWN"><code>StatusCode.SHUTDOWN</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.ContainerLifeCycle">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#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">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>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.util.Collection,java.util.Collection)">updateBeans</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Container">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable.DumpableContainer">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></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>WebSocketClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WebSocketClient</span>()</div> |
| <div class="block">Instantiate a WebSocketClient with defaults</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.client.HttpClient)"> |
| <h3>WebSocketClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WebSocketClient</span><wbr><span class="parameters">(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</span></div> |
| <div class="block">Instantiate a WebSocketClient using HttpClient for defaults</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>httpClient</code> - the HttpClient to base internal defaults off of</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="connect(java.lang.Object,java.net.URI)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Connect to remote websocket endpoint</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>websocket</code> - the websocket object</dd> |
| <dd><code>toUri</code> - the websocket uri to connect to</dd> |
| <dd><code>request</code> - the upgrade request information</dd> |
| <dt>Returns:</dt> |
| <dd>the future for the session, available on success of connect</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to connect</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest,org.eclipse.jetty.websocket.client.JettyUpgradeListener)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></span> <span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> websocket, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request, |
| <a href="JettyUpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client">JettyUpgradeListener</a> upgradeListener)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Connect to remote websocket endpoint</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>websocket</code> - the websocket object</dd> |
| <dd><code>toUri</code> - the websocket uri to connect to</dd> |
| <dd><code>request</code> - the upgrade request information</dd> |
| <dd><code>upgradeListener</code> - the upgrade listener</dd> |
| <dt>Returns:</dt> |
| <dd>the future for the session, available on success of connect</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to connect</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump(java.lang.Appendable,java.lang.String)"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dump</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> out, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> indent)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines. |
| The indent should not be applied to the first object dumped.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code> in interface <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>out</code> - The appendable to dump to</dd> |
| <dd><code>indent</code> - The indent to apply after any new lines.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to write to Appendable</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBehavior()"> |
| <h3>getBehavior</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></span> <span class="element-name">getBehavior</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)"> |
| <h3>addSessionListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSessionListener</span><wbr><span class="parameters">(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>listener</code> - the listener</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeSessionListener(org.eclipse.jetty.websocket.api.WebSocketSessionListener)"> |
| <h3>removeSessionListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeSessionListener</span><wbr><span class="parameters">(<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a> listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>listener</code> - the listener</dd> |
| <dt>Returns:</dt> |
| <dd>true if listener was present and removed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="notifySessionListeners(java.util.function.Consumer)"> |
| <h3>notifySessionListeners</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">notifySessionListeners</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../api/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a>> consumer)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>consumer</code> - the consumer to call for each tracked listener</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIdleTimeout()"> |
| <h3>getIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></span> <span class="element-name">getIdleTimeout</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the timeout duration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInputBufferSize()"> |
| <h3>getInputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getInputBufferSize</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the raw network buffer input size.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputBufferSize()"> |
| <h3>getOutputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getOutputBufferSize</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the raw network buffer output size.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxBinaryMessageSize()"> |
| <h3>getMaxBinaryMessageSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaxBinaryMessageSize</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the maximum size of a binary message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxTextMessageSize()"> |
| <h3>getMaxTextMessageSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaxTextMessageSize</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the maximum size of a text message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxFrameSize()"> |
| <h3>getMaxFrameSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaxFrameSize</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the maximum size of a WebSocket Frame.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAutoFragment()"> |
| <h3>isAutoFragment</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAutoFragment</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>whether to automatically fragment incoming WebSocket Frames.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIdleTimeout(java.time.Duration)"> |
| <h3>setIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIdleTimeout</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> duration)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>duration</code> - the timeout duration (may not be null or negative)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInputBufferSize(int)"> |
| <h3>setInputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setInputBufferSize</span><wbr><span class="parameters">(int size)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>size</code> - the size in bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOutputBufferSize(int)"> |
| <h3>setOutputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOutputBufferSize</span><wbr><span class="parameters">(int size)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>size</code> - the size in bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxBinaryMessageSize(long)"> |
| <h3>setMaxBinaryMessageSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxBinaryMessageSize</span><wbr><span class="parameters">(long size)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>size</code> - the maximum allowed size of a binary message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxTextMessageSize(long)"> |
| <h3>setMaxTextMessageSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxTextMessageSize</span><wbr><span class="parameters">(long size)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>size</code> - the maximum allowed size of a text message.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxFrameSize(long)"> |
| <h3>setMaxFrameSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxFrameSize</span><wbr><span class="parameters">(long maxFrameSize)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>maxFrameSize</code> - the maximum allowed size of a WebSocket Frame.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAutoFragment(boolean)"> |
| <h3>setAutoFragment</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAutoFragment</span><wbr><span class="parameters">(boolean autoFragment)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>autoFragment</code> - whether to automatically fragment incoming WebSocket Frames.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBindAddress()"> |
| <h3>getBindAddress</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></span> <span class="element-name">getBindAddress</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBindAddress(java.net.SocketAddress)"> |
| <h3>setBindAddress</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBindAddress</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> bindAddress)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnectTimeout()"> |
| <h3>getConnectTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getConnectTimeout</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConnectTimeout(long)"> |
| <h3>setConnectTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConnectTimeout</span><wbr><span class="parameters">(long ms)</span></div> |
| <div class="block">Set the timeout for connecting to the remote server.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ms</code> - the timeout in milliseconds</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCookieStore()"> |
| <h3>getCookieStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/CookieStore.html" title="class or interface in java.net" class="external-link">CookieStore</a></span> <span class="element-name">getCookieStore</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCookieStore(java.net.CookieStore)"> |
| <h3>setCookieStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCookieStore</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/CookieStore.html" title="class or interface in java.net" class="external-link">CookieStore</a> cookieStore)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBufferPool()"> |
| <h3>getBufferPool</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></span> <span class="element-name">getBufferPool</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExecutor()"> |
| <h3>getExecutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></span> <span class="element-name">getExecutor</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHttpClient()"> |
| <h3>getHttpClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a></span> <span class="element-name">getHttpClient</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectFactory()"> |
| <h3>getObjectFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></span> <span class="element-name">getObjectFactory</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOpenSessions()"> |
| <h3>getOpenSessions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></span> <span class="element-name">getOpenSessions</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the collection of open sessions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSslContextFactory()"> |
| <h3>getSslContextFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></span> <span class="element-name">getSslContextFactory</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory</code></a> that manages TLS encryption</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStopAtShutdown(boolean)"> |
| <h3>setStopAtShutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStopAtShutdown</span><wbr><span class="parameters">(boolean stop)</span></div> |
| <div class="block">Set JVM shutdown behavior.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stop</code> - If true, this client instance will be explicitly stopped when the |
| JVM is shutdown. Otherwise the application is responsible for maintaining the WebSocketClient lifecycle.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runtime.html#addShutdownHook(java.lang.Thread)" title="class or interface in java.lang" class="external-link"><code>Runtime.addShutdownHook(Thread)</code></a></li> |
| <li><a href="../../util/thread/ShutdownThread.html" title="class in org.eclipse.jetty.util.thread"><code>ShutdownThread</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStopTimeout(long)"> |
| <h3>setStopTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStopTimeout</span><wbr><span class="parameters">(long stopTimeout)</span></div> |
| <div class="block">The timeout to allow all remaining open Sessions to be closed gracefully using the close code <a href="../api/StatusCode.html#SHUTDOWN"><code>StatusCode.SHUTDOWN</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stopTimeout</code> - the time in ms to wait for the graceful close, use a value less than or equal to 0 to not gracefully close.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStopTimeout()"> |
| <h3>getStopTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getStopTimeout</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStopAtShutdown()"> |
| <h3>isStopAtShutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStopAtShutdown</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doStop()"> |
| <h3>doStop</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doStop</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStop()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStop()">doStop</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - If there was a problem stopping. Will cause a transition to FAILED state</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code> in class <code><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
