Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.3.24.v20180605 / org / eclipse / jetty / websocket / common / extensions / identity / IdentityExtension.html
blob: 59651ca0a4127bcbfed0e8c8f5483e17c2940d72 [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:32 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IdentityExtension (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="IdentityExtension (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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IdentityExtension.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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html" target="_top">Frames</a></li>
<li><a href="IdentityExtension.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><a href="#nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a>&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.common.extensions.identity</div>
<h2 title="Class IdentityExtension" class="title">Class IdentityExtension</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">org.eclipse.jetty.websocket.common.extensions.AbstractExtension</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.extensions.identity.IdentityExtension</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>(<a href="../../../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html#value--">value</a>="Identity Extension")
public class <span class="typeNameLabel">IdentityExtension</span>
extends <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../../../../../../../org/eclipse/jetty/util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOP_ON_FAILURE">STOP_ON_FAILURE</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&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/common/extensions/identity/IdentityExtension.html#IdentityExtension--">IdentityExtension</a></span>()</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="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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#getName--">getName</a></span>()</code>
<div class="block">The <code>Sec-WebSocket-Extensions</code> name for this extension.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#getParam-java.lang.String-">getParam</a></span>(java.lang.String&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#incomingError-java.lang.Throwable-">incomingError</a></span>(java.lang.Throwable&nbsp;e)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">incomingFrame</a></span>(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</code>
<div class="block">Process the incoming frame.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#outgoingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-org.eclipse.jetty.websocket.api.WriteCallback-org.eclipse.jetty.websocket.api.BatchMode-">outgoingFrame</a></span>(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../../../../../../org/eclipse/jetty/websocket/api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</code>
<div class="block">A frame, and optional callback, intended for the network layer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#setConfig-org.eclipse.jetty.websocket.api.extensions.ExtensionConfig-">setConfig</a></span>(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.websocket.common.extensions.AbstractExtension">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.websocket.common.extensions.<a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></h3>
<code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#dump--">dump</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#dump-java.lang.Appendable-java.lang.String-">dump</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#dumpWithHeading-java.lang.Appendable-java.lang.String-java.lang.String-java.lang.Object-">dumpWithHeading</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getBufferPool--">getBufferPool</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getConfig--">getConfig</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getConnection--">getConnection</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getNextIncoming--">getNextIncoming</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getNextOutgoing--">getNextOutgoing</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getPolicy--">getPolicy</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#init-org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope-">init</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#isRsv1User--">isRsv1User</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#isRsv2User--">isRsv2User</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#isRsv3User--">isRsv3User</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#nextIncomingError-java.lang.Throwable-">nextIncomingError</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#nextIncomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">nextIncomingFrame</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#nextOutgoingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-org.eclipse.jetty.websocket.api.WriteCallback-org.eclipse.jetty.websocket.api.BatchMode-">nextOutgoingFrame</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setBufferPool-org.eclipse.jetty.io.ByteBufferPool-">setBufferPool</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setConnection-org.eclipse.jetty.websocket.common.LogicalConnection-">setConnection</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setNextIncomingFrames-org.eclipse.jetty.websocket.api.extensions.IncomingFrames-">setNextIncomingFrames</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setNextOutgoingFrames-org.eclipse.jetty.websocket.api.extensions.OutgoingFrames-">setNextOutgoingFrames</a>, <a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setPolicy-org.eclipse.jetty.websocket.api.WebSocketPolicy-">setPolicy</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#addLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">addLifeCycleListener</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#doStart--">doStart</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#doStop--">doStop</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState--">getState</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState-org.eclipse.jetty.util.component.LifeCycle-">getState</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getStopTimeout--">getStopTimeout</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isFailed--">isFailed</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isRunning--">isRunning</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarted--">isStarted</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarting--">isStarting</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopped--">isStopped</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopping--">isStopping</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#removeLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">removeLifeCycleListener</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#setStopTimeout-long-">setStopTimeout</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#start--">start</a>, <a href="../../../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#stop--">stop</a></code></li>
</ul>
<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="IdentityExtension--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IdentityExtension</h4>
<pre>public&nbsp;IdentityExtension()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParam-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParam</h4>
<pre>public&nbsp;java.lang.String&nbsp;getParam(java.lang.String&nbsp;key)</pre>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Extension.html#getName--">Extension</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Extension.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#getName--">getName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the extension</dd>
</dl>
</li>
</ul>
<a name="incomingError-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingError</h4>
<pre>public&nbsp;void&nbsp;incomingError(java.lang.Throwable&nbsp;e)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html#incomingError-java.lang.Throwable-">incomingError</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#incomingError-java.lang.Throwable-">incomingError</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></code></dd>
</dl>
</li>
</ul>
<a name="incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingFrame</h4>
<pre>public&nbsp;void&nbsp;incomingFrame(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html#incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">IncomingFrames</a></code></span></div>
<div class="block">Process the incoming frame.
<p>
Note: if you need to hang onto any information from the frame, be sure
to copy it, as the information contained in the Frame will be released
and/or reused by the implementation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the frame to process</dd>
</dl>
</li>
</ul>
<a name="outgoingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-org.eclipse.jetty.websocket.api.WriteCallback-org.eclipse.jetty.websocket.api.BatchMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outgoingFrame</h4>
<pre>public&nbsp;void&nbsp;outgoingFrame(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../../../../../../org/eclipse/jetty/websocket/api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html#outgoingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-org.eclipse.jetty.websocket.api.WriteCallback-org.eclipse.jetty.websocket.api.BatchMode-">OutgoingFrames</a></code></span></div>
<div class="block">A frame, and optional callback, intended for the network layer.
<p>
Note: the frame can undergo many transformations in the various
layers and extensions present in the implementation.
<p>
If you are implementing a mutation, you are obliged to handle
the incoming WriteCallback appropriately.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the frame to eventually write to the network layer.</dd>
<dd><code>callback</code> - the callback to notify when the frame is written.</dd>
<dd><code>batchMode</code> - the batch mode requested by the sender.</dd>
</dl>
</li>
</ul>
<a name="setConfig-org.eclipse.jetty.websocket.api.extensions.ExtensionConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre>public&nbsp;void&nbsp;setConfig(<a href="../../../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#setConfig-org.eclipse.jetty.websocket.api.extensions.ExtensionConfig-">setConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></code></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><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html#toString--">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/eclipse/jetty/websocket/common/extensions/AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</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>
<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/IdentityExtension.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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/jetty/websocket/common/extensions/identity/IdentityExtension.html" target="_top">Frames</a></li>
<li><a href="IdentityExtension.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><a href="#nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a>&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>