Google Git
Sign in
apache / mina-site / refs/heads/sshd-apidocs / . / org / apache / sshd / common / io / nio2 / Nio2Session.html
blob: 6ccf32025878566a6718df46a1d8d823c9b8ccea [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_66) on Fri Jan 15 14:33:42 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Nio2Session (Apache Mina SSHD :: Core 1.1.0 API)</title>
<meta name="date" content="2016-01-15">
<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="Nio2Session (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":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/Nio2Session.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2ServiceFactoryFactory.html" title="class in org.apache.sshd.common.io.nio2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sshd/common/io/nio2/Nio2Session.html" target="_top">Frames</a></li>
<li><a href="Nio2Session.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.apache.sshd.common.util.closeable.AbstractCloseable">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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.apache.sshd.common.io.nio2</div>
<h2 title="Class Nio2Session" class="title">Class Nio2Session</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><a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">org.apache.sshd.common.util.logging.AbstractLoggingBean</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/sshd/common/util/closeable/IoBaseCloseable.html" title="class in org.apache.sshd.common.util.closeable">org.apache.sshd.common.util.closeable.IoBaseCloseable</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">org.apache.sshd.common.util.closeable.AbstractCloseable</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sshd.common.io.nio2.Nio2Session</li>
</ul>
</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="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a>, <a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Nio2Session</span>
extends <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a>
implements <a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</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.apache.sshd.common.util.closeable.AbstractCloseable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.sshd.common.util.closeable.<a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.State.html" title="enum in org.apache.sshd.common.util.closeable">AbstractCloseable.State</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#DEFAULT_READBUF_SIZE">DEFAULT_READBUF_SIZE</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.common.util.closeable.AbstractCloseable">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sshd.common.util.closeable.<a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#closeFuture">closeFuture</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#lock">lock</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#state">state</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.common.util.logging.AbstractLoggingBean">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sshd.common.util.logging.<a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html#log">log</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/apache/sshd/common/io/nio2/Nio2Session.html#Nio2Session-org.apache.sshd.common.io.nio2.Nio2Service-org.apache.sshd.common.FactoryManager-org.apache.sshd.common.io.IoHandler-java.nio.channels.AsynchronousSocketChannel-">Nio2Session</a></span>(<a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Service.html" title="class in org.apache.sshd.common.io.nio2">Nio2Service</a>&nbsp;service,
<a href="../../../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a>&nbsp;manager,
<a href="../../../../../../org/apache/sshd/common/io/IoHandler.html" title="interface in org.apache.sshd.common.io">IoHandler</a>&nbsp;handler,
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html?is-external=true" title="class or interface in java.nio.channels">AsynchronousSocketChannel</a>&nbsp;socket)</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>protected <a href="../../../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future">CloseFuture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#doCloseGracefully--">doCloseGracefully</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#doCloseImmediately--">doCloseImmediately</a></span>()</code>
<div class="block">doCloseImmediately is called once and only once
with state == Immediate</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#doReadCycle-java.nio.ByteBuffer-org.apache.sshd.common.io.nio2.Nio2CompletionHandler-">doReadCycle</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer,
<a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2CompletionHandler.html" title="class in org.apache.sshd.common.io.nio2">Nio2CompletionHandler</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<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>&gt;&nbsp;completion)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#doReadCycle-java.nio.ByteBuffer-org.apache.sshd.common.util.Readable-">doReadCycle</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer,
<a href="../../../../../../org/apache/sshd/common/util/Readable.html" title="interface in org.apache.sshd.common.util">Readable</a>&nbsp;bufReader)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#getAttribute-java.lang.Object-">getAttribute</a></span>(<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>&nbsp;key)</code>
<div class="block">Returns the value of the user-defined attribute of this session.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#getId--">getId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#getLocalAddress--">getLocalAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#getRemoteAddress--">getRemoteAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sshd/common/io/IoService.html" title="interface in org.apache.sshd.common.io">IoService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#getService--">getService</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#setAttribute-java.lang.Object-java.lang.Object-">setAttribute</a></span>(<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>&nbsp;key,
<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>&nbsp;value)</code>
<div class="block">Sets a user-defined attribute.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#startReading--">startReading</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#startReading-byte:A-">startReading</a></span>(byte[]&nbsp;buf)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#startReading-byte:A-int-int-">startReading</a></span>(byte[]&nbsp;buf,
int&nbsp;offset,
int&nbsp;len)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#startReading-java.nio.ByteBuffer-">startReading</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#startReading-int-">startReading</a></span>(int&nbsp;bufSize)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#suspend--">suspend</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" 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><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Session.html#write-org.apache.sshd.common.util.buffer.Buffer-">write</a></span>(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a>&nbsp;buffer)</code>
<div class="block">Write a packet on the socket.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.util.closeable.AbstractCloseable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sshd.common.util.closeable.<a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#builder--">builder</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#close-boolean-">close</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#isClosed--">isClosed</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#isClosing--">isClosing</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#preClose--">preClose</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.util.closeable.IoBaseCloseable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sshd.common.util.closeable.<a href="../../../../../../org/apache/sshd/common/util/closeable/IoBaseCloseable.html" title="class in org.apache.sshd.common.util.closeable">IoBaseCloseable</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/util/closeable/IoBaseCloseable.html#close--">close</a>, <a href="../../../../../../org/apache/sshd/common/util/closeable/IoBaseCloseable.html#isOpen--">isOpen</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.<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-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.io.IoSession">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.io.<a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#close-boolean-">close</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.Closeable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.<a href="../../../../../../org/apache/sshd/common/Closeable.html" title="interface in org.apache.sshd.common">Closeable</a></h3>
<code><a href="../../../../../../org/apache/sshd/common/Closeable.html#isClosed--">isClosed</a>, <a href="../../../../../../org/apache/sshd/common/Closeable.html#isClosing--">isClosing</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.nio.channels.Channel">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.nio.channels.<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#close--" title="class or interface in java.nio.channels">close</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#isOpen--" title="class or interface in java.nio.channels">isOpen</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_READBUF_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_READBUF_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_READBUF_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sshd.common.io.nio2.Nio2Session.DEFAULT_READBUF_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Nio2Session-org.apache.sshd.common.io.nio2.Nio2Service-org.apache.sshd.common.FactoryManager-org.apache.sshd.common.io.IoHandler-java.nio.channels.AsynchronousSocketChannel-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Nio2Session</h4>
<pre>public&nbsp;Nio2Session(<a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2Service.html" title="class in org.apache.sshd.common.io.nio2">Nio2Service</a>&nbsp;service,
<a href="../../../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a>&nbsp;manager,
<a href="../../../../../../org/apache/sshd/common/io/IoHandler.html" title="interface in org.apache.sshd.common.io">IoHandler</a>&nbsp;handler,
<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html?is-external=true" title="class or interface in java.nio.channels">AsynchronousSocketChannel</a>&nbsp;socket)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;long&nbsp;getId()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getId--">getId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a unique identifier for this session. Every session has its own
ID which is different from each other.</dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>public&nbsp;<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>&nbsp;getAttribute(<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>&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getAttribute-java.lang.Object-">IoSession</a></code></span></div>
<div class="block">Returns the value of the user-defined attribute of this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getAttribute-java.lang.Object-">getAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key of the attribute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>null</tt> if there is no attribute with the specified key</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;<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>&nbsp;setAttribute(<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>&nbsp;key,
<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>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#setAttribute-java.lang.Object-java.lang.Object-">IoSession</a></code></span></div>
<div class="block">Sets a user-defined attribute.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#setAttribute-java.lang.Object-java.lang.Object-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key of the attribute</dd>
<dd><code>value</code> - the value of the attribute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The old value of the attribute. <tt>null</tt> if it is new.</dd>
</dl>
</li>
</ul>
<a name="getRemoteAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;getRemoteAddress()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the socket address of remote peer.</dd>
</dl>
</li>
</ul>
<a name="getLocalAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;getLocalAddress()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getLocalAddress--">getLocalAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the socket address of local machine which is associated with this
session.</dd>
</dl>
</li>
</ul>
<a name="suspend--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suspend</h4>
<pre>public&nbsp;void&nbsp;suspend()</pre>
</li>
</ul>
<a name="write-org.apache.sshd.common.util.buffer.Buffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a>&nbsp;write(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a>&nbsp;buffer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#write-org.apache.sshd.common.util.buffer.Buffer-">IoSession</a></code></span></div>
<div class="block">Write a packet on the socket.
Multiple writes can be issued concurrently and will be queued.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#write-org.apache.sshd.common.util.buffer.Buffer-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The <a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer"><code>Buffer</code></a> with the encoded packet data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io"><code>IoWriteFuture</code></a> for the request</dd>
</dl>
</li>
</ul>
<a name="doCloseGracefully--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCloseGracefully</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future">CloseFuture</a>&nbsp;doCloseGracefully()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#doCloseGracefully--">doCloseGracefully</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="doCloseImmediately--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCloseImmediately</h4>
<pre>protected&nbsp;void&nbsp;doCloseImmediately()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#doCloseImmediately--">AbstractCloseable</a></code></span></div>
<div class="block"><P>doCloseImmediately is called once and only once
with state == Immediate</P>
<P>Overriding methods should always call the base implementation.
It may be called concurrently while preClose() or doCloseGracefully is executing</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html#doCloseImmediately--">doCloseImmediately</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sshd/common/util/closeable/AbstractCloseable.html" title="class in org.apache.sshd.common.util.closeable">AbstractCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="getService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getService</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/sshd/common/io/IoService.html" title="interface in org.apache.sshd.common.io">IoService</a>&nbsp;getService()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html#getService--">getService</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../org/apache/sshd/common/io/IoService.html" title="interface in org.apache.sshd.common.io"><code>IoService</code></a> that created this session.</dd>
</dl>
</li>
</ul>
<a name="startReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre>public&nbsp;void&nbsp;startReading()</pre>
</li>
</ul>
<a name="startReading-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre>public&nbsp;void&nbsp;startReading(int&nbsp;bufSize)</pre>
</li>
</ul>
<a name="startReading-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre>public&nbsp;void&nbsp;startReading(byte[]&nbsp;buf)</pre>
</li>
</ul>
<a name="startReading-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre>public&nbsp;void&nbsp;startReading(byte[]&nbsp;buf,
int&nbsp;offset,
int&nbsp;len)</pre>
</li>
</ul>
<a name="startReading-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startReading</h4>
<pre>public&nbsp;void&nbsp;startReading(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer)</pre>
</li>
</ul>
<a name="doReadCycle-java.nio.ByteBuffer-org.apache.sshd.common.util.Readable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doReadCycle</h4>
<pre>protected&nbsp;void&nbsp;doReadCycle(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer,
<a href="../../../../../../org/apache/sshd/common/util/Readable.html" title="interface in org.apache.sshd.common.util">Readable</a>&nbsp;bufReader)</pre>
</li>
</ul>
<a name="doReadCycle-java.nio.ByteBuffer-org.apache.sshd.common.io.nio2.Nio2CompletionHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doReadCycle</h4>
<pre>protected&nbsp;void&nbsp;doReadCycle(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;buffer,
<a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2CompletionHandler.html" title="class in org.apache.sshd.common.io.nio2">Nio2CompletionHandler</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<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>&gt;&nbsp;completion)</pre>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></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>&nbsp;in class&nbsp;<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>
<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/Nio2Session.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/sshd/common/io/nio2/Nio2ServiceFactoryFactory.html" title="class in org.apache.sshd.common.io.nio2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sshd/common/io/nio2/Nio2Session.html" target="_top">Frames</a></li>
<li><a href="Nio2Session.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.apache.sshd.common.util.closeable.AbstractCloseable">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>