BaseIoSession (MINA 1.1.7 API文档 - 即时通讯网(52im.net))

java.lang.Object
- org.apache.mina.common.support.BaseIoSession

所有已实现的接口:

IoSession

直接已知子类:

VmPipeSessionImpl
```
public abstract class BaseIoSession
extends java.lang.Object
implements IoSession
```
Base implementation of IoSession.

版本:

$Rev: 592279 $, $Date: 2007-11-06 13:59:46 +0900 (Tue, 06 Nov 2007) $

作者:

The Apache Directory Project (mina-dev@directory.apache.org)

构造器概要

构造器
限定符构造器和说明

protected BaseIoSession()

构造器
限定符	构造器和说明
`protected`	`BaseIoSession()`

方法概要

方法
限定符和类型	方法和说明
`CloseFuture`	`close()` Closes this session immediately.
`protected void`	`close0()` Implement this method to perform real close operation.
`boolean`	`containsAttribute(java.lang.String key)` Returns `true` if this session contains the attribute with the specified `key`.
`java.lang.Object`	`getAttachment()` Returns an attachment of this session.
`java.lang.Object`	`getAttribute(java.lang.String key)` Returns the value of user-defined attribute of this session.
`java.util.Set<java.lang.String>`	`getAttributeKeys()` Returns the set of keys of all user-defined attributes.
`CloseFuture`	`getCloseFuture()` Returns the `CloseFuture` of this session.
`long`	`getCreationTime()` Returns the time in millis when this session is created.
`int`	`getIdleCount(IdleStatus status)` Returns the number of the fired continuous `sessionIdle` events for the specified `IdleStatus`.
`int`	`getIdleTime(IdleStatus status)` Returns idle time for the specified type of idleness in seconds.
`long`	`getIdleTimeInMillis(IdleStatus status)` Returns idle time for the specified type of idleness in milliseconds.
`long`	`getLastIdleTime(IdleStatus status)` Returns the time in millis when the last `sessionIdle` event is fired for the specified `IdleStatus`.
`long`	`getLastIoTime()` Returns the time in millis when I/O occurred lastly.
`long`	`getLastReadTime()` Returns the time in millis when read operation occurred lastly.
`long`	`getLastWriteTime()` Returns the time in millis when write operation occurred lastly.
`long`	`getReadBytes()` Returns the total number of bytes which were read from this session.
`long`	`getReadMessages()` Returns the total number of messages which were read and decoded from this session.
`int`	`getScheduledWriteBytes()` Returns the number of bytes which are scheduled to be written to this session.
`int`	`getScheduledWriteRequests()` Returns the number of write requests which are scheduled to be written to this session.
`TrafficMask`	`getTrafficMask()` Returns the current `TrafficMask` of this session.
`int`	`getWriteTimeout()` Returns write timeout in seconds.
`long`	`getWriteTimeoutInMillis()` Returns write timeout in milliseconds.
`long`	`getWrittenBytes()` Returns the total number of bytes which were written to this session.
`long`	`getWrittenMessages()` Returns the total number of messages which were written and encoded by this session.
`long`	`getWrittenWriteRequests()` Returns the total number of write requests which were written to this session.
`void`	`increaseIdleCount(IdleStatus status)`
`void`	`increaseReadBytes(int increment)`
`void`	`increaseReadMessages()`
`void`	`increaseScheduledWriteBytes(int increment)`
`void`	`increaseScheduledWriteRequests()`
`void`	`increaseWrittenBytes(int increment)`
`void`	`increaseWrittenMessages()`
`boolean`	`isClosing()` Returns `true if and only if this session is being closed (but not disconnected yet) or is closed.`
`boolean`	`isConnected()` Returns `true` if this session is connected with remote peer.
`boolean`	`isIdle(IdleStatus status)` Returns `true` if this session is idle for the specified `IdleStatus`.
`boolean`	`isScheduledForFlush()`
`java.lang.Object`	`removeAttribute(java.lang.String key)` Removes a user-defined attribute with the specified key.
`void`	`resumeRead()` A shortcut method for `IoSession.setTrafficMask(TrafficMask)` that resumes read operations for this session.
`void`	`resumeWrite()` A shortcut method for `IoSession.setTrafficMask(TrafficMask)` that resumes write operations for this session.
`java.lang.Object`	`setAttachment(java.lang.Object attachment)` Sets an attachment of this session.
`java.lang.Object`	`setAttribute(java.lang.String key)` Sets a user defined attribute without a value.
`java.lang.Object`	`setAttribute(java.lang.String key, java.lang.Object value)` Sets a user-defined attribute.
`void`	`setIdleTime(IdleStatus status, int idleTime)` Sets idle time for the specified type of idleness in seconds.
`boolean`	`setScheduledForFlush(boolean flag)`
`void`	`setTrafficMask(TrafficMask trafficMask)` Sets the `TrafficMask` of this session which will result the parent `IoService` to start to control the traffic of this session immediately.
`void`	`setWriteTimeout(int writeTimeout)` Sets write timeout in seconds.
`void`	`suspendRead()` A shortcut method for `IoSession.setTrafficMask(TrafficMask)` that suspends read operations for this session.
`void`	`suspendWrite()` A shortcut method for `IoSession.setTrafficMask(TrafficMask)` that suspends write operations for this session.
`java.lang.String`	`toString()`
`protected abstract void`	`updateTrafficMask()` Signals the `IoService` that the `TrafficMask` of this session has been changed.
`WriteFuture`	`write(java.lang.Object message)` Writes the specified `message` to remote peer.
`WriteFuture`	`write(java.lang.Object message, java.net.SocketAddress remoteAddress)`
`protected void`	`write0(IoFilter.WriteRequest writeRequest)` Implement this method to perform real write operation with the specified `writeRequest`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.mina.common.IoSession
getConfig, getFilterChain, getHandler, getLocalAddress, getRemoteAddress, getService, getServiceAddress, getServiceConfig, getTransportType

- 构造器详细资料
  - BaseIoSession
```
protected BaseIoSession()
```
- 方法详细资料
  - isConnected
```
public boolean isConnected()
```
    从接口复制的说明: IoSession
    
    Returns true if this session is connected with remote peer.
    
    指定者:
    
    isConnected 在接口中 IoSession
  - isClosing
```
public boolean isClosing()
```
    从接口复制的说明: IoSession
    
    Returns true if and only if this session is being closed (but not disconnected yet) or is closed.
    指定者: isClosing 在接口中 IoSession
  getCloseFuture public CloseFuture getCloseFuture() 从接口复制的说明: IoSession Returns the CloseFuture of this session. This method returns the same instance whenever user calls it. 指定者: getCloseFuture 在接口中 IoSession isScheduledForFlush public boolean isScheduledForFlush() setScheduledForFlush public boolean setScheduledForFlush(boolean flag) close public CloseFuture close() 从接口复制的说明: IoSession Closes this session immediately. This operation is asynthronous. Wait for the returned CloseFuture if you want to wait for the session actually closed. 指定者: close 在接口中 IoSession close0 protected void close0() Implement this method to perform real close operation. By default, this method is implemented to set the future to 'closed' immediately. write public WriteFuture write(java.lang.Object message) 从接口复制的说明: IoSession Writes the specified message to remote peer. This operation is asynchronous; IoHandler.messageSent(IoSession, Object) will be invoked when the message is actually sent to remote peer. You can also wait for the returned WriteFuture if you want to wait for the message actually written. 指定者: write 在接口中 IoSession write public WriteFuture write(java.lang.Object message, java.net.SocketAddress remoteAddress) write0 protected void write0(IoFilter.WriteRequest writeRequest) Implement this method to perform real write operation with the specified writeRequest. By default, this method is implemented to set the future to 'not written' immediately. 参数: writeRequest - Write request to make getAttachment public java.lang.Object getAttachment() 从接口复制的说明: IoSession Returns an attachment of this session. This method is identical with getAttribute( "" ). 指定者: getAttachment 在接口中 IoSession setAttachment public java.lang.Object setAttachment(java.lang.Object attachment) 从接口复制的说明: IoSession Sets an attachment of this session. This method is identical with setAttribute( "", attachment ). 指定者: setAttachment 在接口中 IoSession 返回: Old attachment. null if it is new. getAttribute public java.lang.Object getAttribute(java.lang.String key) 从接口复制的说明: IoSession Returns the value of user-defined attribute of this session. 指定者: getAttribute 在接口中 IoSession 参数: key - the key of the attribute 返回: null if there is no attribute with the specified key setAttribute public java.lang.Object setAttribute(java.lang.String key, java.lang.Object value) 从接口复制的说明: IoSession Sets a user-defined attribute. 指定者: setAttribute 在接口中 IoSession 参数: key - the key of the attribute value - the value of the attribute 返回: The old value of the attribute. null if it is new. setAttribute public java.lang.Object setAttribute(java.lang.String key) 从接口复制的说明: IoSession Sets a user defined attribute without a value. This is useful when you just want to put a 'mark' attribute. Its value is set to Boolean.TRUE. 指定者: setAttribute 在接口中 IoSession 参数: key - the key of the attribute 返回: The old value of the attribute. null if it is new. removeAttribute public java.lang.Object removeAttribute(java.lang.String key) 从接口复制的说明: IoSession Removes a user-defined attribute with the specified key. 指定者: removeAttribute 在接口中 IoSession 返回: The old value of the attribute. null if not found. containsAttribute public boolean containsAttribute(java.lang.String key) 从接口复制的说明: IoSession Returns true if this session contains the attribute with the specified key. 指定者: containsAttribute 在接口中 IoSession getAttributeKeys public java.util.Set<java.lang.String> getAttributeKeys() 从接口复制的说明: IoSession Returns the set of keys of all user-defined attributes. 指定者: getAttributeKeys 在接口中 IoSession getIdleTime public int getIdleTime(IdleStatus status) 从接口复制的说明: IoSession Returns idle time for the specified type of idleness in seconds. 指定者: getIdleTime 在接口中 IoSession getIdleTimeInMillis public long getIdleTimeInMillis(IdleStatus status) 从接口复制的说明: IoSession Returns idle time for the specified type of idleness in milliseconds. 指定者: getIdleTimeInMillis 在接口中 IoSession setIdleTime public void setIdleTime(IdleStatus status, int idleTime) 从接口复制的说明: IoSession Sets idle time for the specified type of idleness in seconds. 指定者: setIdleTime 在接口中 IoSession getWriteTimeout public int getWriteTimeout() 从接口复制的说明: IoSession Returns write timeout in seconds. 指定者: getWriteTimeout 在接口中 IoSession getWriteTimeoutInMillis public long getWriteTimeoutInMillis() 从接口复制的说明: IoSession Returns write timeout in milliseconds. 指定者: getWriteTimeoutInMillis 在接口中 IoSession setWriteTimeout public void setWriteTimeout(int writeTimeout) 从接口复制的说明: IoSession Sets write timeout in seconds. 指定者: setWriteTimeout 在接口中 IoSession getTrafficMask public TrafficMask getTrafficMask() 从接口复制的说明: IoSession Returns the current TrafficMask of this session. 指定者: getTrafficMask 在接口中 IoSession setTrafficMask public void setTrafficMask(TrafficMask trafficMask) 从接口复制的说明: IoSession Sets the TrafficMask of this session which will result the parent IoService to start to control the traffic of this session immediately. 指定者: setTrafficMask 在接口中 IoSession suspendRead public void suspendRead() 从接口复制的说明: IoSession A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends read operations for this session. 指定者: suspendRead 在接口中 IoSession suspendWrite public void suspendWrite() 从接口复制的说明: IoSession A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends write operations for this session. 指定者: suspendWrite 在接口中 IoSession resumeRead public void resumeRead() 从接口复制的说明: IoSession A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes read operations for this session. 指定者: resumeRead 在接口中 IoSession resumeWrite public void resumeWrite() 从接口复制的说明: IoSession A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes write operations for this session. 指定者: resumeWrite 在接口中 IoSession updateTrafficMask protected abstract void updateTrafficMask() Signals the IoService that the TrafficMask of this session has been changed. getReadBytes public long getReadBytes() 从接口复制的说明: IoSession Returns the total number of bytes which were read from this session. 指定者: getReadBytes 在接口中 IoSession getWrittenBytes public long getWrittenBytes() 从接口复制的说明: IoSession Returns the total number of bytes which were written to this session. 指定者: getWrittenBytes 在接口中 IoSession getWrittenWriteRequests public long getWrittenWriteRequests() 从接口复制的说明: IoSession Returns the total number of write requests which were written to this session. 指定者: getWrittenWriteRequests 在接口中 IoSession getReadMessages public long getReadMessages() 从接口复制的说明: IoSession Returns the total number of messages which were read and decoded from this session. 指定者: getReadMessages 在接口中 IoSession getWrittenMessages public long getWrittenMessages() 从接口复制的说明: IoSession Returns the total number of messages which were written and encoded by this session. 指定者: getWrittenMessages 在接口中 IoSession getScheduledWriteBytes public int getScheduledWriteBytes() 从接口复制的说明: IoSession Returns the number of bytes which are scheduled to be written to this session. 指定者: getScheduledWriteBytes 在接口中 IoSession getScheduledWriteRequests public int getScheduledWriteRequests() 从接口复制的说明: IoSession Returns the number of write requests which are scheduled to be written to this session. 指定者: getScheduledWriteRequests 在接口中 IoSession increaseReadBytes public void increaseReadBytes(int increment) increaseWrittenBytes public void increaseWrittenBytes(int increment) increaseReadMessages public void increaseReadMessages() increaseWrittenMessages public void increaseWrittenMessages() increaseScheduledWriteBytes public void increaseScheduledWriteBytes(int increment) increaseScheduledWriteRequests public void increaseScheduledWriteRequests() getCreationTime public long getCreationTime() 从接口复制的说明: IoSession Returns the time in millis when this session is created. 指定者: getCreationTime 在接口中 IoSession getLastIoTime public long getLastIoTime() 从接口复制的说明: IoSession Returns the time in millis when I/O occurred lastly. 指定者: getLastIoTime 在接口中 IoSession getLastReadTime public long getLastReadTime() 从接口复制的说明: IoSession Returns the time in millis when read operation occurred lastly. 指定者: getLastReadTime 在接口中 IoSession getLastWriteTime public long getLastWriteTime() 从接口复制的说明: IoSession Returns the time in millis when write operation occurred lastly. 指定者: getLastWriteTime 在接口中 IoSession isIdle public boolean isIdle(IdleStatus status) 从接口复制的说明: IoSession Returns true if this session is idle for the specified IdleStatus. 指定者: isIdle 在接口中 IoSession getIdleCount public int getIdleCount(IdleStatus status) 从接口复制的说明: IoSession Returns the number of the fired continuous sessionIdle events for the specified IdleStatus. If sessionIdle event is fired first after some time after I/O, idleCount becomes 1. idleCount resets to 0 if any I/O occurs again, otherwise it increases to 2 and so on if sessionIdle event is fired again without any I/O between two (or more) sessionIdle events. 指定者: getIdleCount 在接口中 IoSession getLastIdleTime public long getLastIdleTime(IdleStatus status) 从接口复制的说明: IoSession Returns the time in millis when the last sessionIdle event is fired for the specified IdleStatus. 指定者: getLastIdleTime 在接口中 IoSession increaseIdleCount public void increaseIdleCount(IdleStatus status) toString public java.lang.String toString() 覆盖: toString 在类中 java.lang.Object

类 BaseIoSession

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.mina.common.IoSession

构造器详细资料

BaseIoSession

方法详细资料

isConnected

isClosing

getCloseFuture

isScheduledForFlush

setScheduledForFlush

close

close0

write

write

write0

getAttachment

setAttachment

getAttribute

setAttribute

setAttribute

removeAttribute

containsAttribute

getAttributeKeys

getIdleTime

getIdleTimeInMillis

setIdleTime

getWriteTimeout

getWriteTimeoutInMillis

setWriteTimeout

getTrafficMask

setTrafficMask

suspendRead

suspendWrite

resumeRead

resumeWrite

updateTrafficMask

getReadBytes

getWrittenBytes

getWrittenWriteRequests

getReadMessages

getWrittenMessages

getScheduledWriteBytes

getScheduledWriteRequests

increaseReadBytes

increaseWrittenBytes

increaseReadMessages

increaseWrittenMessages

increaseScheduledWriteBytes

increaseScheduledWriteRequests

getCreationTime

getLastIoTime

getLastReadTime

getLastWriteTime

isIdle

getIdleCount

getLastIdleTime

increaseIdleCount

toString