Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.3.24.v20180605 / org / eclipse / jetty / websocket / api / WebSocketPolicy.html
blob: 787c0e77a361cdae841bddba506a3131a086f365 [file] [log] [blame]
<!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_92) on Thu Jun 07 14:26:31 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WebSocketPolicy (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<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="WebSocketPolicy (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/WebSocketPolicy.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="../../../../../org/eclipse/jetty/websocket/api/WebSocketPingPongListener.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketTimeoutException.html" title="class in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/WebSocketPolicy.html" target="_top">Frames</a></li>
<li><a href="WebSocketPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.websocket.api</div>
<h2 title="Class WebSocketPolicy" class="title">Class WebSocketPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.api.WebSocketPolicy</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">WebSocketPolicy</span>
extends java.lang.Object</pre>
<div class="block">Settings for WebSocket operations.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#WebSocketPolicy-org.eclipse.jetty.websocket.api.WebSocketBehavior-">WebSocketPolicy</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a>&nbsp;behavior)</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#assertValidBinaryMessageSize-int-">assertValidBinaryMessageSize</a></span>(int&nbsp;requestedSize)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#assertValidTextMessageSize-int-">assertValidTextMessageSize</a></span>(int&nbsp;requestedSize)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#clonePolicy--">clonePolicy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getAsyncWriteTimeout--">getAsyncWriteTimeout</a></span>()</code>
<div class="block">The timeout in ms (milliseconds) for async write operations.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getBehavior--">getBehavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getIdleTimeout--">getIdleTimeout</a></span>()</code>
<div class="block">The time in ms (milliseconds) that a websocket connection mad by idle before being closed automatically.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getInputBufferSize--">getInputBufferSize</a></span>()</code>
<div class="block">The size of the input (read from network layer) buffer size.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxBinaryMessageBufferSize--">getMaxBinaryMessageBufferSize</a></span>()</code>
<div class="block">Get the maximum size of a binary message buffer (for streaming writing)</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxBinaryMessageSize--">getMaxBinaryMessageSize</a></span>()</code>
<div class="block">Get the maximum size of a binary message during parsing/generating.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxTextMessageBufferSize--">getMaxTextMessageBufferSize</a></span>()</code>
<div class="block">Get the maximum size of a text message buffer (for streaming writing)</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxTextMessageSize--">getMaxTextMessageSize</a></span>()</code>
<div class="block">Get the maximum size of a text message during parsing/generating.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#newClientPolicy--">newClientPolicy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#newServerPolicy--">newServerPolicy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setAsyncWriteTimeout-long-">setAsyncWriteTimeout</a></span>(long&nbsp;ms)</code>
<div class="block">The timeout in ms (milliseconds) for async write operations.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setIdleTimeout-long-">setIdleTimeout</a></span>(long&nbsp;ms)</code>
<div class="block">The time in ms (milliseconds) that a websocket may be idle before closing.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setInputBufferSize-int-">setInputBufferSize</a></span>(int&nbsp;size)</code>
<div class="block">The size of the input (read from network layer) buffer size.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxBinaryMessageBufferSize-int-">setMaxBinaryMessageBufferSize</a></span>(int&nbsp;size)</code>
<div class="block">The maximum size of a binary message buffer.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxBinaryMessageSize-int-">setMaxBinaryMessageSize</a></span>(int&nbsp;size)</code>
<div class="block">The maximum size of a binary message during parsing/generating.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxTextMessageBufferSize-int-">setMaxTextMessageBufferSize</a></span>(int&nbsp;size)</code>
<div class="block">The maximum size of a text message buffer.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxTextMessageSize-int-">setMaxTextMessageSize</a></span>(int&nbsp;size)</code>
<div class="block">The maximum size of a text message during parsing/generating.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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, 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="WebSocketPolicy-org.eclipse.jetty.websocket.api.WebSocketBehavior-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketPolicy</h4>
<pre>public&nbsp;WebSocketPolicy(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a>&nbsp;behavior)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newClientPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newClientPolicy</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;newClientPolicy()</pre>
</li>
</ul>
<a name="newServerPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newServerPolicy</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;newServerPolicy()</pre>
</li>
</ul>
<a name="assertValidBinaryMessageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValidBinaryMessageSize</h4>
<pre>public&nbsp;void&nbsp;assertValidBinaryMessageSize(int&nbsp;requestedSize)</pre>
</li>
</ul>
<a name="assertValidTextMessageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValidTextMessageSize</h4>
<pre>public&nbsp;void&nbsp;assertValidTextMessageSize(int&nbsp;requestedSize)</pre>
</li>
</ul>
<a name="clonePolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clonePolicy</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;clonePolicy()</pre>
</li>
</ul>
<a name="getAsyncWriteTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsyncWriteTimeout</h4>
<pre>public&nbsp;long&nbsp;getAsyncWriteTimeout()</pre>
<div class="block">The timeout in ms (milliseconds) for async write operations.
<p>
Negative values indicate a disabled timeout.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout for async write operations. negative values indicate disabled timeout.</dd>
</dl>
</li>
</ul>
<a name="getBehavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBehavior</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a>&nbsp;getBehavior()</pre>
</li>
</ul>
<a name="getIdleTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre>public&nbsp;long&nbsp;getIdleTimeout()</pre>
<div class="block">The time in ms (milliseconds) that a websocket connection mad by idle before being closed automatically.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout in milliseconds for idle timeout.</dd>
</dl>
</li>
</ul>
<a name="getInputBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputBufferSize</h4>
<pre>public&nbsp;int&nbsp;getInputBufferSize()</pre>
<div class="block">The size of the input (read from network layer) buffer size.
<p>
This is the raw read operation buffer size, before the parsing of the websocket frames.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the raw network bytes read operation buffer size.</dd>
</dl>
</li>
</ul>
<a name="getMaxBinaryMessageBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBinaryMessageBufferSize</h4>
<pre>public&nbsp;int&nbsp;getMaxBinaryMessageBufferSize()</pre>
<div class="block">Get the maximum size of a binary message buffer (for streaming writing)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a binary message buffer</dd>
</dl>
</li>
</ul>
<a name="getMaxBinaryMessageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBinaryMessageSize</h4>
<pre>public&nbsp;int&nbsp;getMaxBinaryMessageSize()</pre>
<div class="block">Get the maximum size of a binary message during parsing/generating.
<p>
Binary messages over this maximum will result in a close code 1009 <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a binary message</dd>
</dl>
</li>
</ul>
<a name="getMaxTextMessageBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTextMessageBufferSize</h4>
<pre>public&nbsp;int&nbsp;getMaxTextMessageBufferSize()</pre>
<div class="block">Get the maximum size of a text message buffer (for streaming writing)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a text message buffer</dd>
</dl>
</li>
</ul>
<a name="getMaxTextMessageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTextMessageSize</h4>
<pre>public&nbsp;int&nbsp;getMaxTextMessageSize()</pre>
<div class="block">Get the maximum size of a text message during parsing/generating.
<p>
Text messages over this maximum will result in a close code 1009 <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a text message.</dd>
</dl>
</li>
</ul>
<a name="setAsyncWriteTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsyncWriteTimeout</h4>
<pre>public&nbsp;void&nbsp;setAsyncWriteTimeout(long&nbsp;ms)</pre>
<div class="block">The timeout in ms (milliseconds) for async write operations.
<p>
Negative values indicate a disabled timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ms</code> - the timeout in milliseconds</dd>
</dl>
</li>
</ul>
<a name="setIdleTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdleTimeout</h4>
<pre>public&nbsp;void&nbsp;setIdleTimeout(long&nbsp;ms)</pre>
<div class="block">The time in ms (milliseconds) that a websocket may be idle before closing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ms</code> - the timeout in milliseconds</dd>
</dl>
</li>
</ul>
<a name="setInputBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputBufferSize</h4>
<pre>public&nbsp;void&nbsp;setInputBufferSize(int&nbsp;size)</pre>
<div class="block">The size of the input (read from network layer) buffer size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the size in bytes</dd>
</dl>
</li>
</ul>
<a name="setMaxBinaryMessageBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBinaryMessageBufferSize</h4>
<pre>public&nbsp;void&nbsp;setMaxBinaryMessageBufferSize(int&nbsp;size)</pre>
<div class="block">The maximum size of a binary message buffer.
<p>
Used ONLY for stream based message writing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum size of the binary message buffer</dd>
</dl>
</li>
</ul>
<a name="setMaxBinaryMessageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBinaryMessageSize</h4>
<pre>public&nbsp;void&nbsp;setMaxBinaryMessageSize(int&nbsp;size)</pre>
<div class="block">The maximum size of a binary message during parsing/generating.
<p>
Binary messages over this maximum will result in a close code 1009 <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum allowed size of a binary message.</dd>
</dl>
</li>
</ul>
<a name="setMaxTextMessageBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTextMessageBufferSize</h4>
<pre>public&nbsp;void&nbsp;setMaxTextMessageBufferSize(int&nbsp;size)</pre>
<div class="block">The maximum size of a text message buffer.
<p>
Used ONLY for stream based message writing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum size of the text message buffer</dd>
</dl>
</li>
</ul>
<a name="setMaxTextMessageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTextMessageSize</h4>
<pre>public&nbsp;void&nbsp;setMaxTextMessageSize(int&nbsp;size)</pre>
<div class="block">The maximum size of a text message during parsing/generating.
<p>
Text messages over this maximum will result in a close code 1009 <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum allowed size of a text message.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</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/WebSocketPolicy.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="../../../../../org/eclipse/jetty/websocket/api/WebSocketPingPongListener.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketTimeoutException.html" title="class in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/WebSocketPolicy.html" target="_top">Frames</a></li>
<li><a href="WebSocketPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>