blob: bbfe1fd11e85e1deee48d88c91d892c1cc1005e6 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:40:13 CDT 2020 -->
<title>JettyWebSocketRemoteEndpoint (Jetty :: Javadoc Build 11.0.0.beta3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.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="JettyWebSocketRemoteEndpoint (Jetty :: Javadoc Build 11.0.0.beta3 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JettyWebSocketRemoteEndpoint.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.common</a></div>
<h2 title="Class JettyWebSocketRemoteEndpoint" class="title">Class JettyWebSocketRemoteEndpoint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.JettyWebSocketRemoteEndpoint</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">JettyWebSocketRemoteEndpoint</span>
extends java.lang.Object
implements <a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.api.BatchMode)">JettyWebSocketRemoteEndpoint</a></span>&#8203;(<a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession,
<a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Initiate close of the Remote with no status code (no payload)</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(int,java.lang.String)">close</a></span>&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</code></th>
<td class="colLast">
<div class="block">Initiate close of the Remote with specified status code and optional reason phrase</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush()">flush</a></span>()</code></th>
<td class="colLast">
<div class="block">Flushes messages that may have been batched by the implementation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBatchMode()">getBatchMode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxOutgoingFrames()">getMaxOutgoingFrames</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the maximum number of data frames allowed to be waiting to be sent at any one time.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteAddress()">getRemoteAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the SocketAddress for the established connection.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBytes(java.nio.ByteBuffer)">sendBytes</a></span>&#8203;(java.nio.ByteBuffer&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Send a binary message, returning when all bytes of the message has been transmitted.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendBytes(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendBytes</a></span>&#8203;(java.nio.ByteBuffer&nbsp;data,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Initiates the asynchronous transmission of a binary message.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPartialBytes(java.nio.ByteBuffer,boolean)">sendPartialBytes</a></span>&#8203;(java.nio.ByteBuffer&nbsp;fragment,
boolean&nbsp;isLast)</code></th>
<td class="colLast">
<div class="block">Send a binary message in pieces, blocking until all of the message has been transmitted.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPartialBytes(java.nio.ByteBuffer,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">sendPartialBytes</a></span>&#8203;(java.nio.ByteBuffer&nbsp;fragment,
boolean&nbsp;isLast,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Initiates the asynchronous transmission of a partial binary message.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPartialString(java.lang.String,boolean)">sendPartialString</a></span>&#8203;(java.lang.String&nbsp;fragment,
boolean&nbsp;isLast)</code></th>
<td class="colLast">
<div class="block">Send a text message in pieces, blocking until all of the message has been transmitted.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPartialString(java.lang.String,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">sendPartialString</a></span>&#8203;(java.lang.String&nbsp;fragment,
boolean&nbsp;isLast,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Initiates the asynchronous transmission of a partial text message.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPing(java.nio.ByteBuffer)">sendPing</a></span>&#8203;(java.nio.ByteBuffer&nbsp;applicationData)</code></th>
<td class="colLast">
<div class="block">Send a Ping message containing the given application data to the remote endpoint, blocking until all of the
message has been transmitted.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPing(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendPing</a></span>&#8203;(java.nio.ByteBuffer&nbsp;applicationData,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Asynchronously send a Ping message containing the given application data to the remote endpoint.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPong(java.nio.ByteBuffer)">sendPong</a></span>&#8203;(java.nio.ByteBuffer&nbsp;applicationData)</code></th>
<td class="colLast">
<div class="block">Allows the developer to send an unsolicited Pong message containing the given application data
in order to serve as a unidirectional heartbeat for the session, this will block until
all of the message has been transmitted.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendPong(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendPong</a></span>&#8203;(java.nio.ByteBuffer&nbsp;applicationData,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Allows the developer to asynchronously send an unsolicited Pong message containing the given application data
in order to serve as a unidirectional heartbeat for the session.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendString(java.lang.String)">sendString</a></span>&#8203;(java.lang.String&nbsp;text)</code></th>
<td class="colLast">
<div class="block">Send a text message, blocking until all bytes of the message has been transmitted.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendString(java.lang.String,org.eclipse.jetty.websocket.api.WriteCallback)">sendString</a></span>&#8203;(java.lang.String&nbsp;text,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Initiates the asynchronous transmission of a text message.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBatchMode(org.eclipse.jetty.websocket.api.BatchMode)">setBatchMode</a></span>&#8203;(<a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">Set the batch mode with which messages are sent.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxOutgoingFrames(int)">setMaxOutgoingFrames</a></span>&#8203;(int&nbsp;maxOutgoingFrames)</code></th>
<td class="colLast">
<div class="block">Set the maximum number of data frames allowed to be waiting to be sent at any one time.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="&lt;init&gt;(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.api.BatchMode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JettyWebSocketRemoteEndpoint</h4>
<pre>public&nbsp;JettyWebSocketRemoteEndpoint&#8203;(<a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession,
<a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block">Initiate close of the Remote with no status code (no payload)</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>10.0</dd>
</dl>
</li>
</ul>
<a id="close(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</pre>
<div class="block">Initiate close of the Remote with specified status code and optional reason phrase</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statusCode</code> - the status code (must be valid and can be sent)</dd>
<dd><code>reason</code> - optional reason code</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>10.0</dd>
</dl>
</li>
</ul>
<a id="sendString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendString</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendString&#8203;(java.lang.String&nbsp;text)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendString(java.lang.String)">RemoteEndpoint</a></code></span></div>
<div class="block">Send a text message, blocking until all bytes of the message has been transmitted.
<p>
Note: this is a blocking call</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendString(java.lang.String)">sendString</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the message to be sent</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the text message</dd>
</dl>
</li>
</ul>
<a id="sendString(java.lang.String,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendString</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendString&#8203;(java.lang.String&nbsp;text,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendString(java.lang.String,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Initiates the asynchronous transmission of a text message. This method may return before the message is
transmitted. Developers may provide a callback to
be notified when the message has been transmitted or resulted in an error.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendString(java.lang.String,org.eclipse.jetty.websocket.api.WriteCallback)">sendString</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text being sent</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="sendBytes(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendBytes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendBytes&#8203;(java.nio.ByteBuffer&nbsp;data)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendBytes(java.nio.ByteBuffer)">RemoteEndpoint</a></code></span></div>
<div class="block">Send a binary message, returning when all bytes of the message has been transmitted.
<p>
Note: this is a blocking call</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendBytes(java.nio.ByteBuffer)">sendBytes</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - the message to be sent</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the bytes</dd>
</dl>
</li>
</ul>
<a id="sendBytes(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendBytes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendBytes&#8203;(java.nio.ByteBuffer&nbsp;data,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendBytes(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Initiates the asynchronous transmission of a binary message. This method returns before the message is transmitted.
Developers may provide a callback to be notified when the message has been transmitted or resulted in an error.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendBytes(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendBytes</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - the data being sent</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="sendPartialBytes(java.nio.ByteBuffer,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPartialBytes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPartialBytes&#8203;(java.nio.ByteBuffer&nbsp;fragment,
boolean&nbsp;isLast)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPartialBytes(java.nio.ByteBuffer,boolean)">RemoteEndpoint</a></code></span></div>
<div class="block">Send a binary message in pieces, blocking until all of the message has been transmitted.
The runtime reads the message in order. Non-final pieces are
sent with isLast set to false. The final piece must be sent with isLast set to true.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPartialBytes(java.nio.ByteBuffer,boolean)">sendPartialBytes</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - the piece of the message being sent</dd>
<dd><code>isLast</code> - true if this is the last piece of the partial bytes</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the partial bytes</dd>
</dl>
</li>
</ul>
<a id="sendPartialBytes(java.nio.ByteBuffer,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPartialBytes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPartialBytes&#8203;(java.nio.ByteBuffer&nbsp;fragment,
boolean&nbsp;isLast,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPartialBytes(java.nio.ByteBuffer,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Initiates the asynchronous transmission of a partial binary message. This method returns before the message is
transmitted.
The runtime reads the message in order. Non-final pieces are sent with isLast
set to false. The final piece must be sent with isLast set to true.
Developers may provide a callback to be notified when the message has been transmitted or resulted in an error.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPartialBytes(java.nio.ByteBuffer,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">sendPartialBytes</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - the data being sent</dd>
<dd><code>isLast</code> - true if this is the last piece of the partial bytes</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="sendPartialString(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPartialString</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPartialString&#8203;(java.lang.String&nbsp;fragment,
boolean&nbsp;isLast)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPartialString(java.lang.String,boolean)">RemoteEndpoint</a></code></span></div>
<div class="block">Send a text message in pieces, blocking until all of the message has been transmitted. The runtime reads the
message in order. Non-final pieces are sent
with isLast set to false. The final piece must be sent with isLast set to true.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPartialString(java.lang.String,boolean)">sendPartialString</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - the piece of the message being sent</dd>
<dd><code>isLast</code> - true if this is the last piece of the partial bytes</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the partial bytes</dd>
</dl>
</li>
</ul>
<a id="sendPartialString(java.lang.String,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPartialString</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPartialString&#8203;(java.lang.String&nbsp;fragment,
boolean&nbsp;isLast,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPartialString(java.lang.String,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Initiates the asynchronous transmission of a partial text message.
This method may return before the message is transmitted.
The runtime reads the message in order. Non-final pieces are sent with isLast
set to false. The final piece must be sent with isLast set to true.
Developers may provide a callback to be notified when the message has been transmitted or resulted in an error.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPartialString(java.lang.String,boolean,org.eclipse.jetty.websocket.api.WriteCallback)">sendPartialString</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragment</code> - the text being sent</dd>
<dd><code>isLast</code> - true if this is the last piece of the partial bytes</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="sendPing(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPing</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPing&#8203;(java.nio.ByteBuffer&nbsp;applicationData)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPing(java.nio.ByteBuffer)">RemoteEndpoint</a></code></span></div>
<div class="block">Send a Ping message containing the given application data to the remote endpoint, blocking until all of the
message has been transmitted.
The corresponding Pong message may be picked up using the MessageHandler.Pong handler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPing(java.nio.ByteBuffer)">sendPing</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationData</code> - the data to be carried in the ping request</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the ping</dd>
</dl>
</li>
</ul>
<a id="sendPing(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPing</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPing&#8203;(java.nio.ByteBuffer&nbsp;applicationData,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPing(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Asynchronously send a Ping message containing the given application data to the remote endpoint.
The corresponding Pong message may be picked up using the MessageHandler.Pong handler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPing(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendPing</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationData</code> - the data to be carried in the ping request</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="sendPong(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPong</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPong&#8203;(java.nio.ByteBuffer&nbsp;applicationData)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPong(java.nio.ByteBuffer)">RemoteEndpoint</a></code></span></div>
<div class="block">Allows the developer to send an unsolicited Pong message containing the given application data
in order to serve as a unidirectional heartbeat for the session, this will block until
all of the message has been transmitted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPong(java.nio.ByteBuffer)">sendPong</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationData</code> - the application data to be carried in the pong response.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to send the pong</dd>
</dl>
</li>
</ul>
<a id="sendPong(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPong</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendPong&#8203;(java.nio.ByteBuffer&nbsp;applicationData,
<a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#sendPong(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">RemoteEndpoint</a></code></span></div>
<div class="block">Allows the developer to asynchronously send an unsolicited Pong message containing the given application data
in order to serve as a unidirectional heartbeat for the session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#sendPong(java.nio.ByteBuffer,org.eclipse.jetty.websocket.api.WriteCallback)">sendPong</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationData</code> - the application data to be carried in the pong response.</dd>
<dd><code>callback</code> - callback to notify of success or failure of the write operation</dd>
</dl>
</li>
</ul>
<a id="getBatchMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchMode</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;getBatchMode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#getBatchMode()">getBatchMode</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the batch mode with which messages are sent.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../api/RemoteEndpoint.html#flush()"><code>RemoteEndpoint.flush()</code></a></dd>
</dl>
</li>
</ul>
<a id="setBatchMode(org.eclipse.jetty.websocket.api.BatchMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchMode</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBatchMode&#8203;(<a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;mode)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#setBatchMode(org.eclipse.jetty.websocket.api.BatchMode)">RemoteEndpoint</a></code></span></div>
<div class="block">Set the batch mode with which messages are sent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#setBatchMode(org.eclipse.jetty.websocket.api.BatchMode)">setBatchMode</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - the batch mode to use</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../api/RemoteEndpoint.html#flush()"><code>RemoteEndpoint.flush()</code></a></dd>
</dl>
</li>
</ul>
<a id="getMaxOutgoingFrames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxOutgoingFrames</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxOutgoingFrames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#getMaxOutgoingFrames()">RemoteEndpoint</a></code></span></div>
<div class="block">Get the maximum number of data frames allowed to be waiting to be sent at any one time.
The default value is -1, this indicates there is no limit on how many frames can be
queued to be sent by the implementation. If the limit is exceeded, subsequent frames
sent are failed with a <code>WritePendingException</code> but
the connection is not failed and will remain open.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#getMaxOutgoingFrames()">getMaxOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the max number of frames.</dd>
</dl>
</li>
</ul>
<a id="setMaxOutgoingFrames(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxOutgoingFrames</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxOutgoingFrames&#8203;(int&nbsp;maxOutgoingFrames)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#setMaxOutgoingFrames(int)">RemoteEndpoint</a></code></span></div>
<div class="block">Set the maximum number of data frames allowed to be waiting to be sent at any one time.
The default value is -1, this indicates there is no limit on how many frames can be
queued to be sent by the implementation. If the limit is exceeded, subsequent frames
sent are failed with a <code>WritePendingException</code> but
the connection is not failed and will remain open.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#setMaxOutgoingFrames(int)">setMaxOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxOutgoingFrames</code> - the max number of frames.</dd>
</dl>
</li>
</ul>
<a id="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre class="methodSignature">public&nbsp;java.net.SocketAddress&nbsp;getRemoteAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#getRemoteAddress()">RemoteEndpoint</a></code></span></div>
<div class="block">Get the SocketAddress for the established connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#getRemoteAddress()">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SocketAddress for the established connection.</dd>
</dl>
</li>
</ul>
<a id="flush()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>flush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flush()
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/RemoteEndpoint.html#flush()">RemoteEndpoint</a></code></span></div>
<div class="block">Flushes messages that may have been batched by the implementation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/RemoteEndpoint.html#flush()">flush</a></code>&nbsp;in interface&nbsp;<code><a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the flush fails</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/JettyWebSocketRemoteEndpoint.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>