Google Git
Sign in
apache / qpid-site / 5404ff5f26d72c4c418dd95f4ef04e1fba050c29 / . / content / releases / qpid-proton-j-0.30.0 / api / org / apache / qpid / proton / engine / impl / TransportInternal.html
blob: a619decba26c377e0126f76b83a3cb6528b1c20c [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 -->
<title>TransportInternal (Qpid Proton-J API)</title>
<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="TransportInternal (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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";
</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="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/apache/qpid/proton/engine/impl/TransportInput.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/TransportInternal.html" target="_top">Frames</a></li>
<li><a href="TransportInternal.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>Constr&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>Constr&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.apache.qpid.proton.engine.impl</div>
<h2 title="Interface TransportInternal" class="title">Interface TransportInternal</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportImpl.html" title="class in org.apache.qpid.proton.engine.impl">TransportImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TransportInternal</span>
extends <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></pre>
<div class="block">Extended Transport interface providing access to certain methods intended mainly for internal
use, or use in extending implementation details not strictly considered part of the public
Transport API.</div>
</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.apache.qpid.proton.engine.Transport">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/engine/Transport.Factory.html" title="class in org.apache.qpid.proton.engine">Transport.Factory</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.apache.qpid.proton.engine.Transport">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#DEFAULT_MAX_FRAME_SIZE">DEFAULT_MAX_FRAME_SIZE</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#END_OF_STREAM">END_OF_STREAM</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#MIN_MAX_FRAME_SIZE">MIN_MAX_FRAME_SIZE</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#SESSION_WINDOW">SESSION_WINDOW</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#TRACE_DRV">TRACE_DRV</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#TRACE_FRM">TRACE_FRM</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#TRACE_OFF">TRACE_OFF</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#TRACE_RAW">TRACE_RAW</a></code></li>
</ul>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/apache/qpid/proton/engine/impl/TransportInternal.html#addTransportLayer-org.apache.qpid.proton.engine.impl.TransportLayer-">addTransportLayer</a></span>(<a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl">TransportLayer</a>&nbsp;layer)</code>
<div class="block">Add a <a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl"><code>TransportLayer</code></a> to the transport, wrapping the input and output process handlers
in the state they currently exist.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportInternal.html#isUseReadOnlyOutputBuffer--">isUseReadOnlyOutputBuffer</a></span>()</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/apache/qpid/proton/engine/impl/TransportInternal.html#setUseReadOnlyOutputBuffer-boolean-">setUseReadOnlyOutputBuffer</a></span>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Transport">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#bind-org.apache.qpid.proton.engine.Connection-">bind</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#capacity--">capacity</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#close_head--">close_head</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#close_tail--">close_tail</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getChannelMax--">getChannelMax</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getCondition--">getCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getFramesInput--">getFramesInput</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getFramesOutput--">getFramesOutput</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getIdleTimeout--">getIdleTimeout</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getInputBuffer--">getInputBuffer</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getMaxFrameSize--">getMaxFrameSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getOutboundFrameSizeLimit--">getOutboundFrameSizeLimit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getOutputBuffer--">getOutputBuffer</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getRemoteChannelMax--">getRemoteChannelMax</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getRemoteIdleTimeout--">getRemoteIdleTimeout</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#getRemoteMaxFrameSize--">getRemoteMaxFrameSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#head--">head</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#input-byte:A-int-int-">input</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#isClosed--">isClosed</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#isEmitFlowEventOnSend--">isEmitFlowEventOnSend</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#output-byte:A-int-int-">output</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#outputConsumed--">outputConsumed</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#pending--">pending</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#pop-int-">pop</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#process--">process</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#processInput--">processInput</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#sasl--">sasl</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setChannelMax-int-">setChannelMax</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setEmitFlowEventOnSend-boolean-">setEmitFlowEventOnSend</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setIdleTimeout-int-">setIdleTimeout</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setInitialRemoteMaxFrameSize-int-">setInitialRemoteMaxFrameSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setMaxFrameSize-int-">setMaxFrameSize</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#setOutboundFrameSizeLimit-int-">setOutboundFrameSizeLimit</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#ssl-org.apache.qpid.proton.engine.SslDomain-">ssl</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#ssl-org.apache.qpid.proton.engine.SslDomain-org.apache.qpid.proton.engine.SslPeerDetails-">ssl</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#tail--">tail</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#tick-long-">tick</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#trace-int-">trace</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Transport.html#unbind--">unbind</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Endpoint">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#close--">close</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#free--">free</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getLocalState--">getLocalState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteCondition--">getRemoteCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteState--">getRemoteState</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--">open</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#setCondition-org.apache.qpid.proton.amqp.transport.ErrorCondition-">setCondition</a>, <a href="../../../../../../org/apache/qpid/proton/engine/Endpoint.html#setContext-java.lang.Object-">setContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Extendable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/engine/Extendable.html#attachments--">attachments</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addTransportLayer-org.apache.qpid.proton.engine.impl.TransportLayer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTransportLayer</h4>
<pre>void&nbsp;addTransportLayer(<a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl">TransportLayer</a>&nbsp;layer)
throws java.lang.IllegalStateException</pre>
<div class="block">Add a <a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl"><code>TransportLayer</code></a> to the transport, wrapping the input and output process handlers
in the state they currently exist. No effect if the given layer was previously added.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>layer</code> - the layer to add (if it was not previously added)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if processing has already started.</dd>
</dl>
</li>
</ul>
<a name="setUseReadOnlyOutputBuffer-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseReadOnlyOutputBuffer</h4>
<pre>void&nbsp;setUseReadOnlyOutputBuffer(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="isUseReadOnlyOutputBuffer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isUseReadOnlyOutputBuffer</h4>
<pre>boolean&nbsp;isUseReadOnlyOutputBuffer()</pre>
</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="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/apache/qpid/proton/engine/impl/TransportInput.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/TransportLayer.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/TransportInternal.html" target="_top">Frames</a></li>
<li><a href="TransportInternal.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>