| <!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 (version 1.7.0_80) on Wed Jun 07 15:10:53 EDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>WebSocketPolicy (Jetty :: Project 9.2.22.v20170606 API)</title> |
| <meta name="date" content="2017-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebSocketPolicy (Jetty :: Project 9.2.22.v20170606 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketTimeoutException.html" title="class in org.eclipse.jetty.websocket.api"><span class="strong">Next 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 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>Nested | </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">org.eclipse.jetty.websocket.api</div> |
| <h2 title="Class WebSocketPolicy" class="title">Class WebSocketPolicy</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></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="strong">WebSocketPolicy</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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="overviewSummary" 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><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#WebSocketPolicy(org.eclipse.jetty.websocket.api.WebSocketBehavior)">WebSocketPolicy</a></strong>(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a> behavior)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#assertValidBinaryMessageSize(int)">assertValidBinaryMessageSize</a></strong>(int requestedSize)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#assertValidTextMessageSize(int)">assertValidTextMessageSize</a></strong>(int requestedSize)</code> </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#clonePolicy()">clonePolicy</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getAsyncWriteTimeout()">getAsyncWriteTimeout</a></strong>()</code> |
| <div class="block">The timeout in ms (milliseconds) for async write operations.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getBehavior()">getBehavior</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getIdleTimeout()">getIdleTimeout</a></strong>()</code> |
| <div class="block">The time in ms (milliseconds) that a websocket connection mad by idle before being closed automatically.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getInputBufferSize()">getInputBufferSize</a></strong>()</code> |
| <div class="block">The size of the input (read from network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxBinaryMessageBufferSize()">getMaxBinaryMessageBufferSize</a></strong>()</code> |
| <div class="block">Get the maximum size of a binary message buffer (for streaming writing)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></strong>()</code> |
| <div class="block">Get the maximum size of a binary message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxTextMessageBufferSize()">getMaxTextMessageBufferSize</a></strong>()</code> |
| <div class="block">Get the maximum size of a text message buffer (for streaming writing)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#getMaxTextMessageSize()">getMaxTextMessageSize</a></strong>()</code> |
| <div class="block">Get the maximum size of a text message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#newClientPolicy()">newClientPolicy</a></strong>()</code> </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#newServerPolicy()">newServerPolicy</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setAsyncWriteTimeout(long)">setAsyncWriteTimeout</a></strong>(long ms)</code> |
| <div class="block">The timeout in ms (milliseconds) for async write operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setIdleTimeout(long)">setIdleTimeout</a></strong>(long ms)</code> |
| <div class="block">The time in ms (milliseconds) that a websocket may be idle before closing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setInputBufferSize(int)">setInputBufferSize</a></strong>(int size)</code> |
| <div class="block">The size of the input (read from network layer) buffer size.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxBinaryMessageBufferSize(int)">setMaxBinaryMessageBufferSize</a></strong>(int size)</code> |
| <div class="block">The maximum size of a binary message buffer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxBinaryMessageSize(int)">setMaxBinaryMessageSize</a></strong>(int size)</code> |
| <div class="block">The maximum size of a binary message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxTextMessageBufferSize(int)">setMaxTextMessageBufferSize</a></strong>(int size)</code> |
| <div class="block">The maximum size of a text message buffer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#setMaxTextMessageSize(int)">setMaxTextMessageSize</a></strong>(int size)</code> |
| <div class="block">The maximum size of a text message during parsing/generating.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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 WebSocketPolicy(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a> 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 <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> newClientPolicy()</pre> |
| </li> |
| </ul> |
| <a name="newServerPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newServerPolicy</h4> |
| <pre>public static <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> newServerPolicy()</pre> |
| </li> |
| </ul> |
| <a name="assertValidBinaryMessageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertValidBinaryMessageSize</h4> |
| <pre>public void assertValidBinaryMessageSize(int requestedSize)</pre> |
| </li> |
| </ul> |
| <a name="assertValidTextMessageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertValidTextMessageSize</h4> |
| <pre>public void assertValidTextMessageSize(int requestedSize)</pre> |
| </li> |
| </ul> |
| <a name="clonePolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clonePolicy</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> clonePolicy()</pre> |
| </li> |
| </ul> |
| <a name="getAsyncWriteTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsyncWriteTimeout</h4> |
| <pre>public long 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="strong">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 <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a> getBehavior()</pre> |
| </li> |
| </ul> |
| <a name="getIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre>public long 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="strong">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 int 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="strong">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 int getMaxBinaryMessageBufferSize()</pre> |
| <div class="block">Get the maximum size of a binary message buffer (for streaming writing)</div> |
| <dl><dt><span class="strong">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 int 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="strong">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 int getMaxTextMessageBufferSize()</pre> |
| <div class="block">Get the maximum size of a text message buffer (for streaming writing)</div> |
| <dl><dt><span class="strong">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 int 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="strong">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 void setAsyncWriteTimeout(long 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="strong">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 void setIdleTimeout(long ms)</pre> |
| <div class="block">The time in ms (milliseconds) that a websocket may be idle before closing.</div> |
| <dl><dt><span class="strong">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 void setInputBufferSize(int size)</pre> |
| <div class="block">The size of the input (read from network layer) buffer size.</div> |
| <dl><dt><span class="strong">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 void setMaxBinaryMessageBufferSize(int 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="strong">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 void setMaxBinaryMessageSize(int 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="strong">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 void setMaxTextMessageBufferSize(int 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="strong">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 void setMaxTextMessageSize(int 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="strong">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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketTimeoutException.html" title="class in org.eclipse.jetty.websocket.api"><span class="strong">Next 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 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>Nested | </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 © 1995-2017 <a href="http://webtide.com">Webtide</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |