| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_71) on Tue May 17 00:28:45 UTC 2016 --> |
| <title>WebSocketClientConnector (Quarks v0.4.0)</title> |
| <meta name="date" content="2016-05-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebSocketClientConnector (Quarks v0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketClientConnector.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"> |
| <li><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientBinarySender.html" title="class in quarks.connectors.wsclient.javax.websocket.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientReceiver.html" title="class in quarks.connectors.wsclient.javax.websocket.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html" target="_top">Frames</a></li> |
| <li><a href="WebSocketClientConnector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.quarks.connectors.runtime.Connector">Nested</a> | </li> |
| <li>Field | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">quarks.connectors.wsclient.javax.websocket.runtime</div> |
| <h2 title="Class WebSocketClientConnector" class="title">Class WebSocketClientConnector</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>quarks.connectors.runtime.Connector<javax.websocket.Session></li> |
| <li> |
| <ul class="inheritance"> |
| <li>quarks.connectors.wsclient.javax.websocket.runtime.WebSocketClientConnector</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WebSocketClientConnector</span> |
| extends quarks.connectors.runtime.Connector<javax.websocket.Session> |
| implements java.io.Serializable</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#quarks.connectors.wsclient.javax.websocket.runtime.WebSocketClientConnector">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.quarks.connectors.runtime.Connector"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class quarks.connectors.runtime.Connector</h3> |
| <code>quarks.connectors.runtime.Connector.State</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#WebSocketClientConnector-java.util.Properties-quarks.function.Supplier-">WebSocketClientConnector</a></span>(java.util.Properties config, |
| <a href="../../../../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><javax.websocket.WebSocketContainer> containerFn)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#doClose-javax.websocket.Session-">doClose</a></span>(javax.websocket.Session session)</code> |
| <div class="block">A one-shot request to permanently close the client.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected javax.websocket.Session</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#doConnect-javax.websocket.Session-">doConnect</a></span>(javax.websocket.Session session)</code> |
| <div class="block">A one-shot request to connect the client to its server.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#doDisconnect-javax.websocket.Session-">doDisconnect</a></span>(javax.websocket.Session session)</code> |
| <div class="block">A one-shot request to disconnect the client.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#getLogger--">getLogger</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#id--">id</a></span>()</code> |
| <div class="block">Get a connector id to use in log and exception msgs</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#onBinaryMessage-byte:A-">onBinaryMessage</a></span>(byte[] message)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#onError-javax.websocket.Session-java.lang.Throwable-">onError</a></span>(javax.websocket.Session client, |
| java.lang.Throwable t)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html#onTextMessage-java.lang.String-">onTextMessage</a></span>(java.lang.String message)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.quarks.connectors.runtime.Connector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class quarks.connectors.runtime.Connector</h3> |
| <code>client, close, connectionLost, notIdle, setIdleReconnectInterval, setIdleTimeout</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WebSocketClientConnector-java.util.Properties-quarks.function.Supplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketClientConnector</h4> |
| <pre>public WebSocketClientConnector(java.util.Properties config, |
| <a href="../../../../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><javax.websocket.WebSocketContainer> containerFn)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getLogger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogger</h4> |
| <pre>public org.slf4j.Logger getLogger()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getLogger</code> in class <code>quarks.connectors.runtime.Connector<javax.websocket.Session></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doConnect-javax.websocket.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doConnect</h4> |
| <pre>protected javax.websocket.Session doConnect(javax.websocket.Session session) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>quarks.connectors.runtime.Connector</code></span></div> |
| <div class="block">A one-shot request to connect the client to its server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>doConnect</code> in class <code>quarks.connectors.runtime.Connector<javax.websocket.Session></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the connector's client object. may be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a connected client. not necessarily the same as <code>client</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to connect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doDisconnect-javax.websocket.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doDisconnect</h4> |
| <pre>protected void doDisconnect(javax.websocket.Session session) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>quarks.connectors.runtime.Connector</code></span></div> |
| <div class="block">A one-shot request to disconnect the client.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>doDisconnect</code> in class <code>quarks.connectors.runtime.Connector<javax.websocket.Session></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the connector's client object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to disconnect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doClose-javax.websocket.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doClose</h4> |
| <pre>protected void doClose(javax.websocket.Session session) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>quarks.connectors.runtime.Connector</code></span></div> |
| <div class="block">A one-shot request to permanently close the client.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>doClose</code> in class <code>quarks.connectors.runtime.Connector<javax.websocket.Session></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the connector's client object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to close</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="id--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>id</h4> |
| <pre>protected java.lang.String id()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>quarks.connectors.runtime.Connector</code></span></div> |
| <div class="block">Get a connector id to use in log and exception msgs</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>id</code> in class <code>quarks.connectors.runtime.Connector<javax.websocket.Session></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onError-javax.websocket.Session-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onError</h4> |
| <pre>public void onError(javax.websocket.Session client, |
| java.lang.Throwable t)</pre> |
| </li> |
| </ul> |
| <a name="onTextMessage-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTextMessage</h4> |
| <pre>public void onTextMessage(java.lang.String message)</pre> |
| </li> |
| </ul> |
| <a name="onBinaryMessage-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onBinaryMessage</h4> |
| <pre>public void onBinaryMessage(byte[] message)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketClientConnector.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 class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientBinarySender.html" title="class in quarks.connectors.wsclient.javax.websocket.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientReceiver.html" title="class in quarks.connectors.wsclient.javax.websocket.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?quarks/connectors/wsclient/javax/websocket/runtime/WebSocketClientConnector.html" target="_top">Frames</a></li> |
| <li><a href="WebSocketClientConnector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.quarks.connectors.runtime.Connector">Nested</a> | </li> |
| <li>Field | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p> |
| </body> |
| </html> |
