| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Mon Nov 23 11:46:34 CST 2020 --> |
| <title>Extension (Jetty :: Project 9.4.35.v20201120 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-11-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Extension (Jetty :: Project 9.4.35.v20201120 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Extension.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.api.extensions</a></div> |
| <h2 title="Interface Extension" class="title">Interface Extension</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code>, <code><a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></code>, <code><a href="../../common/extensions/compress/CompressExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">CompressExtension</a></code>, <code><a href="../../common/extensions/compress/DeflateFrameExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">DeflateFrameExtension</a></code>, <code><a href="../../common/extensions/fragment/FragmentExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.fragment">FragmentExtension</a></code>, <code><a href="../../common/extensions/FrameCaptureExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">FrameCaptureExtension</a></code>, <code><a href="../../common/extensions/identity/IdentityExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.identity">IdentityExtension</a></code>, <code><a href="../../common/extensions/compress/PerMessageDeflateExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">PerMessageDeflateExtension</a></code>, <code><a href="../../common/extensions/compress/XWebkitDeflateFrameExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">XWebkitDeflateFrameExtension</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Extension</span> |
| extends <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>, <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></pre> |
| <div class="block">Interface for WebSocket Extensions. |
| <p> |
| That <a href="Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>Frame</code></a>s are passed through the Extension via the <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>IncomingFrames</code></a> and <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>OutgoingFrames</code></a> interfaces</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfig()">getConfig</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The active configuration for this extension.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The <code>Sec-WebSocket-Extensions</code> name for this extension.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv1User()">isRsv1User</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv2User()">isRsv2User</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv3User()">isRsv3User</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a></span>​(<a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a> nextIncoming)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the next <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>IncomingFrames</code></a> to call in the chain.</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="#setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">setNextOutgoingFrames</a></span>​(<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> nextOutgoing)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the next <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>OutgoingFrames</code></a> to call in the chain.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.extensions.IncomingFrames"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.api.extensions.<a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></h3> |
| <code><a href="IncomingFrames.html#incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">incomingFrame</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.extensions.OutgoingFrames"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.api.extensions.<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></h3> |
| <code><a href="OutgoingFrames.html#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre class="methodSignature"><a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a> getConfig()</pre> |
| <div class="block">The active configuration for this extension.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration for this extension. never null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">java.lang.String getName()</pre> |
| <div class="block">The <code>Sec-WebSocket-Extensions</code> name for this extension. |
| <p> |
| Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1"><code>extension-token</code> per Section 9.1. Negotiating Extensions</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the extension</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRsv1User()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv1User</h4> |
| <pre class="methodSignature">boolean isRsv1User()</pre> |
| <div class="block">Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing. |
| <p> |
| This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if extension uses RSV1 for its own purposes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRsv2User()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv2User</h4> |
| <pre class="methodSignature">boolean isRsv2User()</pre> |
| <div class="block">Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing. |
| <p> |
| This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV2.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if extension uses RSV2 for its own purposes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRsv3User()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv3User</h4> |
| <pre class="methodSignature">boolean isRsv3User()</pre> |
| <div class="block">Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing. |
| <p> |
| This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV3.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if extension uses RSV3 for its own purposes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNextIncomingFrames</h4> |
| <pre class="methodSignature">void setNextIncomingFrames​(<a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a> nextIncoming)</pre> |
| <div class="block">Set the next <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>IncomingFrames</code></a> to call in the chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nextIncoming</code> - the next incoming extension</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setNextOutgoingFrames</h4> |
| <pre class="methodSignature">void setNextOutgoingFrames​(<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> nextOutgoing)</pre> |
| <div class="block">Set the next <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>OutgoingFrames</code></a> to call in the chain.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nextOutgoing</code> - the next outgoing extension</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/Extension.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
