| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed Jul 07 10:52:27 EDT 2021 --> |
| <title>WebSocketClient (Jetty :: Project 9.4.43.v20210629 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-07-07"> |
| <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="WebSocketClient (Jetty :: Project 9.4.43.v20210629 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":42,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":42,"i33":10,"i34":42,"i35":10,"i36":10,"i37":42,"i38":10,"i39":10,"i40":10,"i41":10,"i42":42,"i43":42,"i44":10,"i45":10,"i46":42,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.client</a></div> |
| <h2 title="Class WebSocketClient" class="title">Class WebSocketClient</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.client.WebSocketClient</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><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="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WebSocketClient</span> |
| extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></pre> |
| <div class="block">WebSocketClient provides a means of establishing connections to remote websocket endpoints.</div> |
| </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></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> |
| <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#RUNNING">RUNNING</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> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">WebSocketClient</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiate a WebSocketClient with defaults.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.concurrent.Executor)">WebSocketClient</a></span>​(java.util.concurrent.Executor executor)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)">WebSocketClient</a></span>​(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiate a WebSocketClient using provided HttpClient.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.util.DecoratedObjectFactory)">WebSocketClient</a></span>​(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| <a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a> decoratedObjectFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiate a WebSocketClient using HttpClient for defaults</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.io.ByteBufferPool)">WebSocketClient</a></span>​(<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.util.ssl.SslContextFactory)">WebSocketClient</a></span>​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.util.ssl.SslContextFactory,java.util.concurrent.Executor)">WebSocketClient</a></span>​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory, |
| java.util.concurrent.Executor executor)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.util.ssl.SslContextFactory,java.util.concurrent.Executor,org.eclipse.jetty.io.ByteBufferPool)">WebSocketClient</a></span>​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory, |
| java.util.concurrent.Executor executor, |
| <a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">WebSocketClient</a></span>​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.util.ssl.SslContextFactory)">WebSocketClient</a></span>​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory)">WebSocketClient</a></span>​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory, |
| <a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory,org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(WebSocketContainerScope, EventDriverFactory, SessionFactory, HttpClient)</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory,org.eclipse.jetty.client.HttpClient)">WebSocketClient</a></span>​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory, |
| <a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</code></th> |
| <td class="colLast"> |
| <div class="block">Create WebSocketClient based on pre-existing Container Scope, to allow sharing of |
| internal features like Executor, ByteBufferPool, SSLContextFactory, etc.</div> |
| </td> |
| </tr> |
| </table> |
| </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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">addSessionListener</a></span>​(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<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="#connect(java.lang.Object,java.net.URI)">connect</a></span>​(java.lang.Object websocket, |
| java.net.URI toUri)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<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="#connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)">connect</a></span>​(java.lang.Object websocket, |
| java.net.URI toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Connect to remote websocket endpoint</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<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="#connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest,org.eclipse.jetty.websocket.client.io.UpgradeListener)">connect</a></span>​(java.lang.Object websocket, |
| java.net.URI toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request, |
| <a href="io/UpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client.io">UpgradeListener</a> upgradeListener)</code></th> |
| <td class="colLast"> |
| <div class="block">Connect to remote websocket endpoint</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object o)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncWriteTimeout()">getAsyncWriteTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBindAddress()">getBindAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The configured Container Buffer Pool.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.ClassLoader</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassLoader()">getClassLoader</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The ClassLoader used to load classes for the WebSocketSession.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="io/ConnectionManager.html" title="class in org.eclipse.jetty.websocket.client.io">ConnectionManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionManager()">getConnectionManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectTimeout()">getConnectTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.net.CookieStore</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookieStore()">getCookieStore</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventDriverFactory()">getEventDriverFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Executor</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Executor in use by the container.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensionFactory()">getExtensionFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpClient()">getHttpClient</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="masks/Masker.html" title="interface in org.eclipse.jetty.websocket.client.masks">Masker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMasker()">getMasker</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, no replacement</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxBinaryMessageBufferSize()">getMaxBinaryMessageBufferSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the maximum size for buffering of a binary message.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <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 for a binary message.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxIdleTimeout()">getMaxIdleTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the max idle timeout for new connections.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxTextMessageBufferSize()">getMaxTextMessageBufferSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the maximum size for buffering of a text message.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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 for a text message.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectFactory()">getObjectFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Object Factory used to create objects.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<a href="../common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenSessions()">getOpenSessions</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The policy the container is running on.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduler()">getScheduler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionFactory()">getSessionFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionListeners()">getSessionListeners</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslContextFactory()">getSslContextFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the in use <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory</code></a></div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDispatchIO()">isDispatchIO</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStopAtShutdown()">isStopAtShutdown</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected <a href="io/ConnectionManager.html" title="class in org.eclipse.jetty.websocket.client.io">ConnectionManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newConnectionManager()">newConnectionManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">has no replacement</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">removeSessionListener</a></span>​(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAsyncWriteTimeout(long)">setAsyncWriteTimeout</a></span>​(long ms)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBindAdddress(java.net.SocketAddress)">setBindAdddress</a></span>​(java.net.SocketAddress bindAddress)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">(this is a bad bad bad typo, it has 3 { @ code " d " } characters in a row) use <a href="../../client/HttpClient.html#setBindAddress(java.net.SocketAddress)"><code>HttpClient.setBindAddress(SocketAddress)</code></a> |
| to the internal <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBindAddress(java.net.SocketAddress)">setBindAddress</a></span>​(java.net.SocketAddress bindAddress)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the Bind Address on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBufferPool(org.eclipse.jetty.io.ByteBufferPool)">setBufferPool</a></span>​(<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code></th> |
| <td class="colLast"> |
| <div class="block">Set's the Bind Address on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnectTimeout(long)">setConnectTimeout</a></span>​(long ms)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the timeout for connecting to the remote server on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCookieStore(java.net.CookieStore)">setCookieStore</a></span>​(java.net.CookieStore cookieStore)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the <code>CookieStore</code> to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDaemon(boolean)">setDaemon</a></span>​(boolean daemon)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, configure threading in <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDispatchIO(boolean)">setDispatchIO</a></span>​(boolean dispatchIO)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">no longer used, this has no replacement</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventDriverFactory(org.eclipse.jetty.websocket.common.events.EventDriverFactory)">setEventDriverFactory</a></span>​(<a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutor(java.util.concurrent.Executor)">setExecutor</a></span>​(java.util.concurrent.Executor executor)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the Executor in use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMasker(org.eclipse.jetty.websocket.client.masks.Masker)">setMasker</a></span>​(<a href="masks/Masker.html" title="interface in org.eclipse.jetty.websocket.client.masks">Masker</a> masker)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, no replacement</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxBinaryMessageBufferSize(int)">setMaxBinaryMessageBufferSize</a></span>​(int max)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxIdleTimeout(long)">setMaxIdleTimeout</a></span>​(long ms)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the max idle timeout for new connections.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxTextMessageBufferSize(int)">setMaxTextMessageBufferSize</a></span>​(int max)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionFactory(org.eclipse.jetty.websocket.common.SessionFactory)">setSessionFactory</a></span>​(<a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStopAtShutdown(boolean)">setStopAtShutdown</a></span>​(boolean stop)</code></th> |
| <td class="colLast"> |
| <div class="block">Set JVM shutdown behavior.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </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(org.eclipse.jetty.util.component.Container.Listener)">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#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#dump(java.lang.Appendable,java.lang.String,java.util.Collection...)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(org.eclipse.jetty.util.component.Dumpable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpBeans(java.lang.Appendable,java.lang.String,java.util.Collection...)">dumpBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObject(java.lang.Appendable,java.lang.Object)">dumpObject</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#dumpThis(java.lang.Appendable)">dumpThis</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(org.eclipse.jetty.util.component.Container.Listener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#setStopTimeout(long)">setStopTimeout</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#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</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#getStopTimeout()">getStopTimeout</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#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</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, finalize, getClass, 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.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.websocket.common.scopes.WebSocketContainerScope"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></h3> |
| <code><a href="../common/scopes/WebSocketContainerScope.html#isRunning()">isRunning</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>public WebSocketClient()</pre> |
| <div class="block">Instantiate a WebSocketClient with defaults.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.client.HttpClient)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>public WebSocketClient​(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</pre> |
| <div class="block">Instantiate a WebSocketClient using provided HttpClient.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpClient</code> - the HttpClient to use for WebSocketClient.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.util.DecoratedObjectFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>public WebSocketClient​(<a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| <a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a> decoratedObjectFactory)</pre> |
| <div class="block">Instantiate a WebSocketClient using HttpClient for defaults</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpClient</code> - the HttpClient that underlying WebSocket client uses</dd> |
| <dd><code>decoratedObjectFactory</code> - the DecoratedObjectFactory for all client instantiated classes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.util.ssl.SslContextFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create a new WebSocketClient</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslContextFactory</code> - ssl context factory to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.concurrent.Executor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(java.util.concurrent.Executor executor)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create a new WebSocketClient</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executor</code> - the executor to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.io.ByteBufferPool)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create a new WebSocketClient</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bufferPool</code> - byte buffer pool to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.util.ssl.SslContextFactory,java.util.concurrent.Executor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory, |
| java.util.concurrent.Executor executor)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create a new WebSocketClient</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslContextFactory</code> - ssl context factory to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| <dd><code>executor</code> - the executor to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create WebSocketClient other Container Scope, to allow sharing of |
| internal features like Executor, ByteBufferPool, SSLContextFactory, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the Container Scope</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.util.ssl.SslContextFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create WebSocketClient other Container Scope, to allow sharing of |
| internal features like Executor, ByteBufferPool, SSLContextFactory, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the Container Scope</dd> |
| <dd><code>sslContextFactory</code> - SSL ContextFactory to use in preference to one from |
| <a href="../common/scopes/WebSocketContainerScope.html#getSslContextFactory()"><code>WebSocketContainerScope.getSslContextFactory()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.util.ssl.SslContextFactory,java.util.concurrent.Executor,org.eclipse.jetty.io.ByteBufferPool)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory, |
| java.util.concurrent.Executor executor, |
| <a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create WebSocketClient using sharing instances of SSLContextFactory |
| Executor, and ByteBufferPool</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslContextFactory</code> - shared SSL ContextFactory</dd> |
| <dd><code>executor</code> - shared Executor</dd> |
| <dd><code>bufferPool</code> - shared ByteBufferPool</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>@Deprecated |
| public WebSocketClient​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory, |
| <a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory,org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(WebSocketContainerScope, EventDriverFactory, SessionFactory, HttpClient)</code></a> instead</div> |
| </div> |
| <div class="block">Create WebSocketClient based on pre-existing Container Scope, to allow sharing of |
| internal features like Executor, ByteBufferPool, SSLContextFactory, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the Container Scope</dd> |
| <dd><code>eventDriverFactory</code> - the EventDriver Factory to use</dd> |
| <dd><code>sessionFactory</code> - the SessionFactory to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,org.eclipse.jetty.websocket.common.events.EventDriverFactory,org.eclipse.jetty.websocket.common.SessionFactory,org.eclipse.jetty.client.HttpClient)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketClient</h4> |
| <pre>public WebSocketClient​(<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> scope, |
| <a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory, |
| <a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient)</pre> |
| <div class="block">Create WebSocketClient based on pre-existing Container Scope, to allow sharing of |
| internal features like Executor, ByteBufferPool, SSLContextFactory, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the Container Scope</dd> |
| <dd><code>eventDriverFactory</code> - the EventDriver Factory to use</dd> |
| <dd><code>sessionFactory</code> - the SessionFactory to use</dd> |
| <dd><code>httpClient</code> - the httpClient to use</dd> |
| </dl> |
| </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="connect(java.lang.Object,java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> connect​(java.lang.Object websocket, |
| java.net.URI toUri) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> connect​(java.lang.Object websocket, |
| java.net.URI toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request) |
| throws java.io.IOException</pre> |
| <div class="block">Connect to remote websocket endpoint</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the future for the session, available on success of connect</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to connect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="connect(java.lang.Object,java.net.URI,org.eclipse.jetty.websocket.client.ClientUpgradeRequest,org.eclipse.jetty.websocket.client.io.UpgradeListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> connect​(java.lang.Object websocket, |
| java.net.URI toUri, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request, |
| <a href="io/UpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client.io">UpgradeListener</a> upgradeListener) |
| throws java.io.IOException</pre> |
| <div class="block">Connect to remote websocket endpoint</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the future for the session, available on success of connect</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to connect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClassLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassLoader</h4> |
| <pre class="methodSignature">public java.lang.ClassLoader getClassLoader()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../common/scopes/WebSocketContainerScope.html#getClassLoader()">WebSocketContainerScope</a></code></span></div> |
| <div class="block"><p>The ClassLoader used to load classes for the WebSocketSession.</p> |
| <p>By default this will be the ContextClassLoader at the time this method is called. However this will be overridden |
| by the WebSocketClient to use the ContextClassLoader at the time it was created, this is because the |
| client uses its own <a href="../../util/thread/ThreadPool.html" title="interface in org.eclipse.jetty.util.thread"><code>ThreadPool</code></a> so the WebSocketSessions may be created when |
| the ContextClassLoader is not set.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getClassLoader()">getClassLoader</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the classloader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEventDriverFactory(org.eclipse.jetty.websocket.common.events.EventDriverFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEventDriverFactory</h4> |
| <pre class="methodSignature">public void setEventDriverFactory​(<a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> eventDriverFactory)</pre> |
| </li> |
| </ul> |
| <a id="setSessionFactory(org.eclipse.jetty.websocket.common.SessionFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionFactory</h4> |
| <pre class="methodSignature">public void setSessionFactory​(<a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</pre> |
| </li> |
| </ul> |
| <a id="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre class="methodSignature">protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStart()">doStart</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre class="methodSignature">protected void doStop() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDispatchIO()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDispatchIO</h4> |
| <pre class="methodSignature">@Deprecated |
| public boolean isDispatchIO()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="getAsyncWriteTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsyncWriteTimeout</h4> |
| <pre class="methodSignature">@Deprecated |
| public long getAsyncWriteTimeout()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return the number of milliseconds for a timeout of an attempted write operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of milliseconds for timeout of an attempted write operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBindAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindAddress</h4> |
| <pre class="methodSignature">public java.net.SocketAddress getBindAddress()</pre> |
| </li> |
| </ul> |
| <a id="getBufferPool()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferPool</h4> |
| <pre class="methodSignature">public <a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> getBufferPool()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../common/scopes/WebSocketContainerScope.html#getBufferPool()">WebSocketContainerScope</a></code></span></div> |
| <div class="block">The configured Container Buffer Pool.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getBufferPool()">getBufferPool</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the buffer pool (never null)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConnectionManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionManager</h4> |
| <pre class="methodSignature">@Deprecated |
| public <a href="io/ConnectionManager.html" title="class in org.eclipse.jetty.websocket.client.io">ConnectionManager</a> getConnectionManager()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="getConnectTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectTimeout</h4> |
| <pre class="methodSignature">public long getConnectTimeout()</pre> |
| </li> |
| </ul> |
| <a id="getCookieStore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCookieStore</h4> |
| <pre class="methodSignature">public java.net.CookieStore getCookieStore()</pre> |
| </li> |
| </ul> |
| <a id="getEventDriverFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventDriverFactory</h4> |
| <pre class="methodSignature">public <a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> getEventDriverFactory()</pre> |
| </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="../common/scopes/WebSocketContainerScope.html#getExecutor()">WebSocketContainerScope</a></code></span></div> |
| <div class="block">Executor in use by the container.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getExecutor()">getExecutor</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Executor in use by the container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExtensionFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensionFactory</h4> |
| <pre class="methodSignature">public <a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a> getExtensionFactory()</pre> |
| </li> |
| </ul> |
| <a id="getMasker()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMasker</h4> |
| <pre class="methodSignature">@Deprecated |
| public <a href="masks/Masker.html" title="interface in org.eclipse.jetty.websocket.client.masks">Masker</a> getMasker()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, no replacement</div> |
| </div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="masks/RandomMasker.html" title="class in org.eclipse.jetty.websocket.client.masks"><code>RandomMasker</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxBinaryMessageBufferSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxBinaryMessageBufferSize</h4> |
| <pre class="methodSignature">public int getMaxBinaryMessageBufferSize()</pre> |
| <div class="block">Get the maximum size for buffering of a binary message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a binary message buffer.</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">Get the maximum size for a binary message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a binary message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxIdleTimeout</h4> |
| <pre class="methodSignature">public long getMaxIdleTimeout()</pre> |
| <div class="block">Get the max idle timeout for new connections.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the max idle timeout in milliseconds for new connections.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxTextMessageBufferSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxTextMessageBufferSize</h4> |
| <pre class="methodSignature">public int getMaxTextMessageBufferSize()</pre> |
| <div class="block">Get the maximum size for buffering of a text message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a text message buffer.</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">Get the maximum size for a text message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of a text message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getObjectFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectFactory</h4> |
| <pre class="methodSignature">public <a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a> getObjectFactory()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../common/scopes/WebSocketContainerScope.html#getObjectFactory()">WebSocketContainerScope</a></code></span></div> |
| <div class="block">Object Factory used to create objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getObjectFactory()">getObjectFactory</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object Factory used to create instances of objects.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOpenSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenSessions</h4> |
| <pre class="methodSignature">public java.util.Set<<a href="../common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>> getOpenSessions()</pre> |
| </li> |
| </ul> |
| <a id="getPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre class="methodSignature">public <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../common/scopes/WebSocketContainerScope.html#getPolicy()">WebSocketContainerScope</a></code></span></div> |
| <div class="block">The policy the container is running on.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getPolicy()">getPolicy</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the websocket policy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getScheduler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduler</h4> |
| <pre class="methodSignature">public <a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a> getScheduler()</pre> |
| </li> |
| </ul> |
| <a id="getSessionFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionFactory</h4> |
| <pre class="methodSignature">public <a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> getSessionFactory()</pre> |
| </li> |
| </ul> |
| <a id="getSslContextFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslContextFactory</h4> |
| <pre class="methodSignature">public <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> getSslContextFactory()</pre> |
| <div class="block">Get the in use <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getSslContextFactory()">getSslContextFactory</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></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 on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#%3Cinit%3E(org.eclipse.jetty.util.ssl.SslContextFactory)"><code>WebSocketClient(SslContextFactory)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSessionListener</h4> |
| <pre class="methodSignature">public void addSessionListener​(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">addSessionListener</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSessionListener</h4> |
| <pre class="methodSignature">public void removeSessionListener​(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">removeSessionListener</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionListeners</h4> |
| <pre class="methodSignature">public java.util.Collection<<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>> getSessionListeners()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../common/scopes/WebSocketContainerScope.html#getSessionListeners()">getSessionListeners</a></code> in interface <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newConnectionManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newConnectionManager</h4> |
| <pre class="methodSignature">@Deprecated |
| protected <a href="io/ConnectionManager.html" title="class in org.eclipse.jetty.websocket.client.io">ConnectionManager</a> newConnectionManager()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">has no replacement</div> |
| </div> |
| <div class="block">Factory method for new ConnectionManager</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ConnectionManager instance to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAsyncWriteTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAsyncWriteTimeout</h4> |
| <pre class="methodSignature">public void setAsyncWriteTimeout​(long ms)</pre> |
| </li> |
| </ul> |
| <a id="setBindAdddress(java.net.SocketAddress)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBindAdddress</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setBindAdddress​(java.net.SocketAddress bindAddress)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">(this is a bad bad bad typo, it has 3 { @ code " d " } characters in a row) use <a href="../../client/HttpClient.html#setBindAddress(java.net.SocketAddress)"><code>HttpClient.setBindAddress(SocketAddress)</code></a> |
| to the internal <a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)"><code>WebSocketClient(HttpClient)</code></a></div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bindAddress</code> - the address to bind to the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBindAddress(java.net.SocketAddress)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBindAddress</h4> |
| <pre class="methodSignature">public void setBindAddress​(java.net.SocketAddress bindAddress)</pre> |
| <div class="block">Sets the Bind Address on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bindAddress</code> - the local bind address for the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBufferPool(org.eclipse.jetty.io.ByteBufferPool)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBufferPool</h4> |
| <pre class="methodSignature">public void setBufferPool​(<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| <div class="block">Set's the Bind Address on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bufferPool</code> - The buffer pool</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConnectTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectTimeout</h4> |
| <pre class="methodSignature">public void setConnectTimeout​(long ms)</pre> |
| <div class="block">Set the timeout for connecting to the remote server on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ms</code> - the timeout in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCookieStore(java.net.CookieStore)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCookieStore</h4> |
| <pre class="methodSignature">public void setCookieStore​(java.net.CookieStore cookieStore)</pre> |
| <div class="block">Set the <code>CookieStore</code> to use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookieStore</code> - The cookie store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDaemon(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDaemon</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setDaemon​(boolean daemon)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, configure threading in <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>daemon</code> - do nothing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDispatchIO(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDispatchIO</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setDispatchIO​(boolean dispatchIO)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">no longer used, this has no replacement</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatchIO</code> - true to have IO operations be dispatched to Executor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExecutor(java.util.concurrent.Executor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutor</h4> |
| <pre class="methodSignature">public void setExecutor​(java.util.concurrent.Executor executor)</pre> |
| <div class="block">Sets the Executor in use on the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executor</code> - The executor to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMasker(org.eclipse.jetty.websocket.client.masks.Masker)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMasker</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setMasker​(<a href="masks/Masker.html" title="interface in org.eclipse.jetty.websocket.client.masks">Masker</a> masker)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">not used, no replacement</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>masker</code> - does nothing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxBinaryMessageBufferSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxBinaryMessageBufferSize</h4> |
| <pre class="methodSignature">public void setMaxBinaryMessageBufferSize​(int max)</pre> |
| </li> |
| </ul> |
| <a id="setMaxIdleTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxIdleTimeout</h4> |
| <pre class="methodSignature">public void setMaxIdleTimeout​(long ms)</pre> |
| <div class="block">Set the max idle timeout for new connections. |
| <p> |
| Existing connections will not have their max idle timeout adjusted.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ms</code> - the timeout in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxTextMessageBufferSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxTextMessageBufferSize</h4> |
| <pre class="methodSignature">public void setMaxTextMessageBufferSize​(int max)</pre> |
| </li> |
| </ul> |
| <a id="getHttpClient()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpClient</h4> |
| <pre class="methodSignature">public <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> getHttpClient()</pre> |
| <div class="block">Get the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a>. |
| <p> |
| Note: this can result in a <code>LinkageError</code> if used within a WebApp that runs |
| on a server that also has <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> on the server classpath. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the internal <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStopAtShutdown(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStopAtShutdown</h4> |
| <pre class="methodSignature">public void setStopAtShutdown​(boolean stop)</pre> |
| <div class="block">Set JVM shutdown behavior.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Runtime.addShutdownHook(Thread)</code>, |
| <a href="../../util/thread/ShutdownThread.html" title="class in org.eclipse.jetty.util.thread"><code>ShutdownThread</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isStopAtShutdown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStopAtShutdown</h4> |
| <pre class="methodSignature">public boolean isStopAtShutdown()</pre> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(java.lang.Object o)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></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> |
| </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/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">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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |