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

java.lang.Object
- org.apache.mina.core.session.AbstractIoSession

所有已实现的接口:

IoSession

直接已知子类:

AprSession, DummySession, NioSession
```
public abstract class AbstractIoSession
extends java.lang.Object
implements IoSession
```
Base implementation of IoSession.

作者:

Apache MINA Project

字段概要

字段
限定符和类型字段和说明

protected IoSessionConfig config
The session config

字段
限定符和类型	字段和说明
`protected IoSessionConfig`	`config` The session config

构造器概要

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

protected AbstractIoSession(IoService service)
Create a Session for a service

构造器
限定符	构造器和说明
`protected`	`AbstractIoSession(IoService service)` Create a Session for a service

方法概要

方法
限定符和类型	方法和说明
`CloseFuture`	`close()` Closes this session after all queued write requests are flushed.
`CloseFuture`	`close(boolean rightNow)` Closes this session immediately or after all queued write requests are flushed.
`CloseFuture`	`closeNow()` Closes this session immediately.
`CloseFuture`	`closeOnFlush()` Closes this session after all queued write requests are flushed.
`boolean`	`containsAttribute(java.lang.Object key)`
`void`	`decreaseReadBufferSize()` Decrease the ReadBuffer size (it will be divided by a factor 2)
`void`	`decreaseScheduledBytesAndMessages(WriteRequest request)` Decrease the counters of written messages and written bytes when a message has been written
`boolean`	`equals(java.lang.Object o)` TODO This is a ridiculous implementation.
`java.lang.Object`	`getAttachment()` Returns an attachment of this session.
`java.lang.Object`	`getAttribute(java.lang.Object key)` Returns the value of the user-defined attribute of this session.
`java.lang.Object`	`getAttribute(java.lang.Object key, java.lang.Object defaultValue)` Returns the value of user defined attribute associated with the specified key.
`java.util.Set<java.lang.Object>`	`getAttributeKeys()`
`IoSessionAttributeMap`	`getAttributeMap()`
`int`	`getBothIdleCount()`
`CloseFuture`	`getCloseFuture()`
`IoSessionConfig`	`getConfig()`
`long`	`getCreationTime()`
`java.lang.Object`	`getCurrentWriteMessage()` Returns the message which is being written by `IoService`.
`WriteRequest`	`getCurrentWriteRequest()` Returns the `WriteRequest` which is being processed by `IoService`.
`IoHandler`	`getHandler()`
`long`	`getId()` We use an AtomicLong to guarantee that the session ID are unique.
`int`	`getIdleCount(IdleStatus status)`
`long`	`getLastBothIdleTime()`
`long`	`getLastIdleTime(IdleStatus status)`
`long`	`getLastIoTime()`
`long`	`getLastReaderIdleTime()`
`long`	`getLastReadTime()`
`long`	`getLastWriterIdleTime()`
`long`	`getLastWriteTime()`
`abstract IoProcessor`	`getProcessor()`
`long`	`getReadBytes()`
`double`	`getReadBytesThroughput()`
`int`	`getReaderIdleCount()`
`long`	`getReadMessages()`
`double`	`getReadMessagesThroughput()`
`long`	`getScheduledWriteBytes()`
`int`	`getScheduledWriteMessages()`
`IoService`	`getService()`
`java.net.SocketAddress`	`getServiceAddress()`
`WriteRequestQueue`	`getWriteRequestQueue()` Get the queue that contains the message waiting for being written.
`int`	`getWriterIdleCount()`
`long`	`getWrittenBytes()`
`double`	`getWrittenBytesThroughput()`
`long`	`getWrittenMessages()`
`double`	`getWrittenMessagesThroughput()`
`int`	`hashCode()`
`void`	`increaseIdleCount(IdleStatus status, long currentTime)` Increase the count of the various Idle counter
`void`	`increaseReadBufferSize()` Increase the ReadBuffer size (it will double)
`void`	`increaseReadBytes(long increment, long currentTime)` Increase the number of read bytes
`void`	`increaseReadMessages(long currentTime)` Increase the number of read messages
`void`	`increaseScheduledWriteBytes(int increment)` Increase the number of scheduled write bytes for the session
`void`	`increaseScheduledWriteMessages()` Increase the number of scheduled message to write
`void`	`increaseWrittenBytes(int increment, long currentTime)` Increase the number of written bytes
`void`	`increaseWrittenMessages(WriteRequest request, long currentTime)` Increase the number of written messages
`boolean`	`isActive()`
`boolean`	`isBothIdle()`
`boolean`	`isClosing()`
`boolean`	`isConnected()`
`boolean`	`isIdle(IdleStatus status)`
`boolean`	`isReaderIdle()`
`boolean`	`isReadSuspended()` Is read operation is suspended for this session.
`boolean`	`isScheduledForFlush()` Tells if the session is scheduled for flushed
`boolean`	`isSecured()`
`boolean`	`isWriterIdle()`
`boolean`	`isWriteSuspended()` Is write operation is suspended for this session.
`static void`	`notifyIdleness(java.util.Iterator<? extends IoSession> sessions, long currentTime)` Fires a `IoEventType.SESSION_IDLE` event to any applicable sessions in the specified collection.
`static void`	`notifyIdleSession(IoSession session, long currentTime)` Fires a `IoEventType.SESSION_IDLE` event if applicable for the specified `session`.
`void`	`offerClosedReadFuture()` Inform the ReadFuture that the session has been closed
`void`	`offerFailedReadFuture(java.lang.Throwable exception)` Associates a failure to a ReadFuture
`void`	`offerReadFuture(java.lang.Object message)` Associates a message to a ReadFuture
`ReadFuture`	`read()` TODO This javadoc is wrong.
`java.lang.Object`	`removeAttribute(java.lang.Object key)` Removes a user-defined attribute with the specified key.
`boolean`	`removeAttribute(java.lang.Object key, java.lang.Object value)` Removes a user defined attribute with the specified key if the current attribute value is equal to the specified value.
`boolean`	`replaceAttribute(java.lang.Object key, java.lang.Object oldValue, java.lang.Object newValue)` Replaces a user defined attribute with the specified key if the value of the attribute is equals to the specified old value.
`void`	`resumeRead()` Resumes read operations for this session.
`void`	`resumeWrite()` Resumes write operations for this session.
`void`	`scheduledForFlush()` Schedule the session for flushed
`java.lang.Object`	`setAttachment(java.lang.Object attachment)` Sets an attachment of this session.
`java.lang.Object`	`setAttribute(java.lang.Object key)` Sets a user defined attribute without a value.
`java.lang.Object`	`setAttribute(java.lang.Object key, java.lang.Object value)` Sets a user-defined attribute.
`java.lang.Object`	`setAttributeIfAbsent(java.lang.Object key)` Sets a user defined attribute without a value if the attribute with the specified key is not set yet.
`java.lang.Object`	`setAttributeIfAbsent(java.lang.Object key, java.lang.Object value)` Sets a user defined attribute if the attribute with the specified key is not set yet.
`void`	`setAttributeMap(IoSessionAttributeMap attributes)` Set the map of attributes associated with the session
`void`	`setCurrentWriteRequest(WriteRequest currentWriteRequest)` Associate the current write request with the session
`boolean`	`setScheduledForFlush(boolean schedule)` Set the scheduledForFLush flag.
`protected void`	`setScheduledWriteBytes(int byteCount)` Set the number of scheduled write bytes
`protected void`	`setScheduledWriteMessages(int messages)` Set the number of scheduled write messages
`void`	`setWriteRequestQueue(WriteRequestQueue writeRequestQueue)` Create a new close aware write queue, based on the given write queue.
`void`	`suspendRead()` Suspends read operations for this session.
`void`	`suspendWrite()` Suspends write operations for this session.
`java.lang.String`	`toString()`
`void`	`unscheduledForFlush()` Change the session's status : it's not anymore scheduled for flush
`void`	`updateThroughput(long currentTime, boolean force)` Update all statistical properties related with throughput assuming the specified time is the current time.
`WriteFuture`	`write(java.lang.Object message)` Writes the specified `message` to remote peer.
`WriteFuture`	`write(java.lang.Object message, java.net.SocketAddress remoteAddress)` (Optional) Writes the specified `message` to the specified `destination`.

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

从接口继承的方法 org.apache.mina.core.session.IoSession
getFilterChain, getLocalAddress, getRemoteAddress, getTransportMetadata

- 字段详细资料
  - config
```
protected IoSessionConfig config
```
    The session config
- 构造器详细资料
  - AbstractIoSession
```
protected AbstractIoSession(IoService service)
```
    Create a Session for a service
    
    参数:
    service - the Service for this session
- 方法详细资料
  - getId
```
public final long getId()
```
    We use an AtomicLong to guarantee that the session ID are unique.
    
    指定者:
    
    getId 在接口中 IoSession
    
    返回:
    a unique identifier for this session. Every session has its own ID which is different from each other. TODO : The way it's implemented does not guarantee that the contract is respected. It uses the HashCode() method which don't guarantee the key unicity.
  - getProcessor
```
public abstract IoProcessor getProcessor()
```
    返回:
    The associated IoProcessor for this session
  - isConnected
```
public final boolean isConnected()
```
    指定者:
    
    isConnected 在接口中 IoSession
    
    返回:
    true if this session is connected with remote peer.
  - isActive
```
public boolean isActive()
```
    指定者:
    
    isActive 在接口中 IoSession
    
    返回:
    true if this session is active.
  - isClosing
```
public final boolean isClosing()
```
    指定者:
    
    isClosing 在接口中 IoSession
    
    返回:
    true if and only if this session is being closed (but not disconnected yet) or is closed.
  - isSecured
```
public boolean isSecured()
```
    指定者:
    
    isSecured 在接口中 IoSession
    
    返回:
    true if the session has started and initialized a SslEngine, false if the session is not yet secured (the handshake is not completed) or if SSL is not set for this session, or if SSL is not even an option.
  - getCloseFuture
```
public final CloseFuture getCloseFuture()
```
    指定者:
    
    getCloseFuture 在接口中 IoSession
    
    返回:
    the CloseFuture of this session. This method returns the same instance whenever user calls it.
  - isScheduledForFlush
```
public final boolean isScheduledForFlush()
```
    Tells if the session is scheduled for flushed
    
    返回:
    true if the session is scheduled for flush
  - scheduledForFlush
```
public final void scheduledForFlush()
```
    Schedule the session for flushed
  - unscheduledForFlush
```
public final void unscheduledForFlush()
```
    Change the session's status : it's not anymore scheduled for flush
  - setScheduledForFlush
```
public final boolean setScheduledForFlush(boolean schedule)
```
    Set the scheduledForFLush flag. As we may have concurrent access to this flag, we compare and set it in one call.
    
    参数:
    schedule - the new value to set if not already set.
    
    返回:
    true if the session flag has been set, and if it wasn't set already.
  - close
```
public final CloseFuture close(boolean rightNow)
```
    Closes this session immediately or after all queued write requests are flushed. This operation is asynchronous. Wait for the returned CloseFuture if you want to wait for the session actually closed.
    
    指定者:
    
    close 在接口中 IoSession
    
    参数:
    rightNow - true to close this session immediately . The pending write requests will simply be discarded. false to close this session after all queued write requests are flushed.
    
    返回:
    The associated CloseFuture
  - close
```
public final CloseFuture close()
```
    Closes this session after all queued write requests are flushed. This operation is asynchronous. Wait for the returned CloseFuture if you want to wait for the session actually closed.
    
    指定者:
    
    close 在接口中 IoSession
    
    返回:
    The associated CloseFuture
  - closeOnFlush
```
public final CloseFuture closeOnFlush()
```
    Closes this session after all queued write requests are flushed. This operation is asynchronous. Wait for the returned CloseFuture if you want to wait for the session actually closed.
    
    指定者:
    
    closeOnFlush 在接口中 IoSession
    
    返回:
    The associated CloseFuture
  - closeNow
```
public final CloseFuture closeNow()
```
    Closes this session immediately. This operation is asynchronous, it returns a CloseFuture.
    
    指定者:
    
    closeNow 在接口中 IoSession
  - getHandler
```
public IoHandler getHandler()
```
    指定者:
    
    getHandler 在接口中 IoSession
    
    返回:
    the IoHandler which handles this session.
  - getConfig
```
public IoSessionConfig getConfig()
```
    指定者:
    
    getConfig 在接口中 IoSession
    
    返回:
    the configuration of this session.
  - read
```
public final ReadFuture read()
```
    TODO This javadoc is wrong. The return tag should be short.
    
    指定者:
    
    read 在接口中 IoSession
    
    返回:
    a ReadFuture which is notified when a new message is received, the connection is closed or an exception is caught. This operation is especially useful when you implement a client application. TODO : Describe here how we enable this feature. However, please note that this operation is disabled by default and throw IllegalStateException because all received events must be queued somewhere to support this operation, possibly leading to memory leak. This means you have to keep calling IoSession.read() once you enabled this operation. To enable this operation, please call IoSessionConfig.setUseReadOperation(boolean) with true.
  - offerReadFuture
```
public final void offerReadFuture(java.lang.Object message)
```
    Associates a message to a ReadFuture
    
    参数:
    message - the message to associate to the ReadFuture
  - offerFailedReadFuture
```
public final void offerFailedReadFuture(java.lang.Throwable exception)
```
    Associates a failure to a ReadFuture
    
    参数:
    exception - the exception to associate to the ReadFuture
  - offerClosedReadFuture
```
public final void offerClosedReadFuture()
```
    Inform the ReadFuture that the session has been closed
  - write
```
public WriteFuture write(java.lang.Object message)
```
    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
    
    参数:
    message - The message to write
    
    返回:
    The associated WriteFuture
  - write
```
public WriteFuture write(java.lang.Object message,
                java.net.SocketAddress remoteAddress)
```
    (Optional) Writes the specified message to the specified destination. 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.
    When you implement a client that receives a broadcast message from a server such as DHCP server, the client might need to send a response message for the broadcast message the server sent. Because the remote address of the session is not the address of the server in case of broadcasting, there should be a way to specify the destination when you write the response message. This interface provides IoSession.write(Object, SocketAddress) method so you can specify the destination.
    
    指定者:
    
    write 在接口中 IoSession
    
    参数:
    message - The message to write
    remoteAddress - null if you want the message sent to the default remote address
    
    返回:
    The associated WriteFuture
  - getAttachment
```
public final java.lang.Object getAttachment()
```
    Returns an attachment of this session. This method is identical with getAttribute( "" ).
    
    指定者:
    
    getAttachment 在接口中 IoSession
    
    返回:
    The attachment
  - setAttachment
```
public final java.lang.Object setAttachment(java.lang.Object attachment)
```
    Sets an attachment of this session. This method is identical with setAttribute( "", attachment ).
    
    指定者:
    
    setAttachment 在接口中 IoSession
    
    参数:
    attachment - The attachment
    
    返回:
    Old attachment. null if it is new.
  - getAttribute
```
public final java.lang.Object getAttribute(java.lang.Object key)
```
    Returns the value of the user-defined attribute of this session.
    
    指定者:
    
    getAttribute 在接口中 IoSession
    
    参数:
    key - the key of the attribute
    
    返回:
    null if there is no attribute with the specified key
  - getAttribute
```
public final java.lang.Object getAttribute(java.lang.Object key,
                            java.lang.Object defaultValue)
```
    Returns the value of user defined attribute associated with the specified key. If there's no such attribute, the specified default value is associated with the specified key, and the default value is returned. This method is same with the following code except that the operation is performed atomically.
```
 if (containsAttribute(key)) {
     return getAttribute(key);
 } else {
     setAttribute(key, defaultValue);
     return defaultValue;
 }
 
```
    指定者:
    
    getAttribute 在接口中 IoSession
    
    参数:
    key - the key of the attribute we want to retreive
    defaultValue - the default value of the attribute
    
    返回:
    The retrieved attribute or null if not found
  - setAttribute
```
public final java.lang.Object setAttribute(java.lang.Object key,
                            java.lang.Object value)
```
    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 final java.lang.Object setAttribute(java.lang.Object key)
```
    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.
  - setAttributeIfAbsent
```
public final java.lang.Object setAttributeIfAbsent(java.lang.Object key,
                                    java.lang.Object value)
```
    Sets a user defined attribute if the attribute with the specified key is not set yet. This method is same with the following code except that the operation is performed atomically.
```
 if (containsAttribute(key)) {
     return getAttribute(key);
 } else {
     return setAttribute(key, value);
 }
 
```
    指定者:
    
    setAttributeIfAbsent 在接口中 IoSession
    
    参数:
    key - The key of the attribute we want to set
    value - The value we want to set
    
    返回:
    The old value of the attribute. null if not found.
  - setAttributeIfAbsent
```
public final java.lang.Object setAttributeIfAbsent(java.lang.Object key)
```
    Sets a user defined attribute without a value if the attribute with the specified key is not set yet. This is useful when you just want to put a 'mark' attribute. Its value is set to Boolean.TRUE. This method is same with the following code except that the operation is performed atomically.
```
 if (containsAttribute(key)) {
     return getAttribute(key);  // might not always be Boolean.TRUE.
 } else {
     return setAttribute(key);
 }
 
```
    指定者:
    
    setAttributeIfAbsent 在接口中 IoSession
    
    参数:
    key - The key of the attribute we want to set
    
    返回:
    The old value of the attribute. null if not found.
  - removeAttribute
```
public final java.lang.Object removeAttribute(java.lang.Object key)
```
    Removes a user-defined attribute with the specified key.
    
    指定者:
    
    removeAttribute 在接口中 IoSession
    
    参数:
    key - The key of the attribute we want to remove
    
    返回:
    The old value of the attribute. null if not found.
  - removeAttribute
```
public final boolean removeAttribute(java.lang.Object key,
                      java.lang.Object value)
```
    Removes a user defined attribute with the specified key if the current attribute value is equal to the specified value. This method is same with the following code except that the operation is performed atomically.
```
 if (containsAttribute(key) && getAttribute(key).equals(value)) {
     removeAttribute(key);
     return true;
 } else {
     return false;
 }
 
```
    指定者:
    
    removeAttribute 在接口中 IoSession
    
    参数:
    key - The key we want to remove
    value - The value we want to remove
    
    返回:
    true if the removal was successful
  - replaceAttribute
```
public final boolean replaceAttribute(java.lang.Object key,
                       java.lang.Object oldValue,
                       java.lang.Object newValue)
```
    Replaces a user defined attribute with the specified key if the value of the attribute is equals to the specified old value. This method is same with the following code except that the operation is performed atomically.
```
 if (containsAttribute(key) && getAttribute(key).equals(oldValue)) {
     setAttribute(key, newValue);
     return true;
 } else {
     return false;
 }
 
```
    指定者:
    
    replaceAttribute 在接口中 IoSession
    
    参数:
    key - The key we want to replace
    oldValue - The previous value
    newValue - The new value
    
    返回:
    true if the replacement was successful
  - containsAttribute
```
public final boolean containsAttribute(java.lang.Object key)
```
    指定者:
    
    containsAttribute 在接口中 IoSession
    
    参数:
    key - The key of the attribute we are looking for in the session
    
    返回:
    true if this session contains the attribute with the specified key.
  - getAttributeKeys
```
public final java.util.Set<java.lang.Object> getAttributeKeys()
```
    指定者:
    
    getAttributeKeys 在接口中 IoSession
    
    返回:
    the set of keys of all user-defined attributes.
  - getAttributeMap
```
public final IoSessionAttributeMap getAttributeMap()
```
    返回:
    The map of attributes associated with the session
  - setAttributeMap
```
public final void setAttributeMap(IoSessionAttributeMap attributes)
```
    Set the map of attributes associated with the session
    
    参数:
    attributes - The Map of attributes
  - setWriteRequestQueue
```
public final void setWriteRequestQueue(WriteRequestQueue writeRequestQueue)
```
    Create a new close aware write queue, based on the given write queue.
    
    参数:
    writeRequestQueue - The write request queue
  - suspendRead
```
public final void suspendRead()
```
    Suspends read operations for this session.
    
    指定者:
    
    suspendRead 在接口中 IoSession
  - suspendWrite
```
public final void suspendWrite()
```
    Suspends write operations for this session.
    
    指定者:
    
    suspendWrite 在接口中 IoSession
  - resumeRead
```
public final void resumeRead()
```
    Resumes read operations for this session.
    
    指定者:
    
    resumeRead 在接口中 IoSession
  - resumeWrite
```
public final void resumeWrite()
```
    Resumes write operations for this session.
    
    指定者:
    
    resumeWrite 在接口中 IoSession
  - isReadSuspended
```
public boolean isReadSuspended()
```
    Is read operation is suspended for this session.
    
    指定者:
    
    isReadSuspended 在接口中 IoSession
    
    返回:
    true if suspended
  - isWriteSuspended
```
public boolean isWriteSuspended()
```
    Is write operation is suspended for this session.
    
    指定者:
    
    isWriteSuspended 在接口中 IoSession
    
    返回:
    true if suspended
  - getReadBytes
```
public final long getReadBytes()
```
    指定者:
    
    getReadBytes 在接口中 IoSession
    
    返回:
    the total number of bytes which were read from this session.
  - getWrittenBytes
```
public final long getWrittenBytes()
```
    指定者:
    
    getWrittenBytes 在接口中 IoSession
    
    返回:
    the total number of bytes which were written to this session.
  - getReadMessages
```
public final long getReadMessages()
```
    指定者:
    
    getReadMessages 在接口中 IoSession
    
    返回:
    the total number of messages which were read and decoded from this session.
  - getWrittenMessages
```
public final long getWrittenMessages()
```
    指定者:
    
    getWrittenMessages 在接口中 IoSession
    
    返回:
    the total number of messages which were written and encoded by this session.
  - getReadBytesThroughput
```
public final double getReadBytesThroughput()
```
    指定者:
    
    getReadBytesThroughput 在接口中 IoSession
    
    返回:
    the number of read bytes per second.
  - getWrittenBytesThroughput
```
public final double getWrittenBytesThroughput()
```
    指定者:
    
    getWrittenBytesThroughput 在接口中 IoSession
    
    返回:
    the number of written bytes per second.
  - getReadMessagesThroughput
```
public final double getReadMessagesThroughput()
```
    指定者:
    
    getReadMessagesThroughput 在接口中 IoSession
    
    返回:
    the number of read messages per second.
  - getWrittenMessagesThroughput
```
public final double getWrittenMessagesThroughput()
```
    指定者:
    
    getWrittenMessagesThroughput 在接口中 IoSession
    
    返回:
    the number of written messages per second.
  - updateThroughput
```
public final void updateThroughput(long currentTime,
                    boolean force)
```
    Update all statistical properties related with throughput assuming the specified time is the current time. By default this method returns silently without updating the throughput properties if they were calculated already within last calculation interval. If, however, force is specified as true, this method updates the throughput properties immediately.
    
    指定者:
    
    updateThroughput 在接口中 IoSession
    
    参数:
    currentTime - the current time in milliseconds
    force - Force the update if true
  - getScheduledWriteBytes
```
public final long getScheduledWriteBytes()
```
    指定者:
    
    getScheduledWriteBytes 在接口中 IoSession
    
    返回:
    the number of bytes which are scheduled to be written to this session.
  - getScheduledWriteMessages
```
public final int getScheduledWriteMessages()
```
    指定者:
    
    getScheduledWriteMessages 在接口中 IoSession
    
    返回:
    the number of messages which are scheduled to be written to this session.
  - setScheduledWriteBytes
```
protected void setScheduledWriteBytes(int byteCount)
```
    Set the number of scheduled write bytes
    
    参数:
    byteCount - The number of scheduled bytes for write
  - setScheduledWriteMessages
```
protected void setScheduledWriteMessages(int messages)
```
    Set the number of scheduled write messages
    
    参数:
    messages - The number of scheduled messages for write
  - increaseReadBytes
```
public final void increaseReadBytes(long increment,
                     long currentTime)
```
    Increase the number of read bytes
    
    参数:
    increment - The number of read bytes
    currentTime - The current time
  - increaseReadMessages
```
public final void increaseReadMessages(long currentTime)
```
    Increase the number of read messages
    
    参数:
    currentTime - The current time
  - increaseWrittenBytes
```
public final void increaseWrittenBytes(int increment,
                        long currentTime)
```
    Increase the number of written bytes
    
    参数:
    increment - The number of written bytes
    currentTime - The current time
  - increaseWrittenMessages
```
public final void increaseWrittenMessages(WriteRequest request,
                           long currentTime)
```
    Increase the number of written messages
    
    参数:
    request - The written message
    currentTime - The current tile
  - increaseScheduledWriteBytes
```
public final void increaseScheduledWriteBytes(int increment)
```
    Increase the number of scheduled write bytes for the session
    
    参数:
    increment - The number of newly added bytes to write
  - increaseScheduledWriteMessages
```
public final void increaseScheduledWriteMessages()
```
    Increase the number of scheduled message to write
  - decreaseScheduledBytesAndMessages
```
public final void decreaseScheduledBytesAndMessages(WriteRequest request)
```
    Decrease the counters of written messages and written bytes when a message has been written
    
    参数:
    request - The written message
  - getWriteRequestQueue
```
public final WriteRequestQueue getWriteRequestQueue()
```
    Get the queue that contains the message waiting for being written. As the reader might not be ready, it's frequent that the messages aren't written completely, or that some older messages are waiting to be written when a new message arrives. This queue is used to manage the backlog of messages.
    
    指定者:
    
    getWriteRequestQueue 在接口中 IoSession
    
    返回:
    The queue containing the pending messages.
  - getCurrentWriteRequest
```
public final WriteRequest getCurrentWriteRequest()
```
    Returns the WriteRequest which is being processed by IoService.
    
    指定者:
    
    getCurrentWriteRequest 在接口中 IoSession
    
    返回:
    null if and if only no message is being written
  - getCurrentWriteMessage
```
public final java.lang.Object getCurrentWriteMessage()
```
    Returns the message which is being written by IoService.
    
    指定者:
    
    getCurrentWriteMessage 在接口中 IoSession
    
    返回:
    null if and if only no message is being written
  - setCurrentWriteRequest
```
public final void setCurrentWriteRequest(WriteRequest currentWriteRequest)
```
    Associate the current write request with the session
    
    指定者:
    
    setCurrentWriteRequest 在接口中 IoSession
    
    参数:
    currentWriteRequest - the current write request to associate
  - increaseReadBufferSize
```
public final void increaseReadBufferSize()
```
    Increase the ReadBuffer size (it will double)
  - decreaseReadBufferSize
```
public final void decreaseReadBufferSize()
```
    Decrease the ReadBuffer size (it will be divided by a factor 2)
  - getCreationTime
```
public final long getCreationTime()
```
    指定者:
    
    getCreationTime 在接口中 IoSession
    
    返回:
    the session's creation time in milliseconds
  - getLastIoTime
```
public final long getLastIoTime()
```
    指定者:
    
    getLastIoTime 在接口中 IoSession
    
    返回:
    the time in millis when I/O occurred lastly.
  - getLastReadTime
```
public final long getLastReadTime()
```
    指定者:
    
    getLastReadTime 在接口中 IoSession
    
    返回:
    the time in millis when read operation occurred lastly.
  - getLastWriteTime
```
public final long getLastWriteTime()
```
    指定者:
    
    getLastWriteTime 在接口中 IoSession
    
    返回:
    the time in millis when write operation occurred lastly.
  - isIdle
```
public final boolean isIdle(IdleStatus status)
```
    指定者:
    
    isIdle 在接口中 IoSession
    
    参数:
    status - The researched idle status
    
    返回:
    true if this session is idle for the specified IdleStatus.
  - isBothIdle
```
public final boolean isBothIdle()
```
    指定者:
    
    isBothIdle 在接口中 IoSession
    
    返回:
    true if this session is IdleStatus.BOTH_IDLE.
    另请参阅:
    IoSession.isIdle(IdleStatus)
  - isReaderIdle
```
public final boolean isReaderIdle()
```
    指定者:
    
    isReaderIdle 在接口中 IoSession
    
    返回:
    true if this session is IdleStatus.READER_IDLE.
    另请参阅:
    IoSession.isIdle(IdleStatus)
  - isWriterIdle
```
public final boolean isWriterIdle()
```
    指定者:
    
    isWriterIdle 在接口中 IoSession
    
    返回:
    true if this session is IdleStatus.WRITER_IDLE.
    另请参阅:
    IoSession.isIdle(IdleStatus)
  - getIdleCount
```
public final int getIdleCount(IdleStatus status)
```
    指定者:
    
    getIdleCount 在接口中 IoSession
    
    参数:
    status - The researched idle status
    
    返回:
    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.
  - getLastIdleTime
```
public final long getLastIdleTime(IdleStatus status)
```
    指定者:
    
    getLastIdleTime 在接口中 IoSession
    
    参数:
    status - The researched idle status
    
    返回:
    the time in milliseconds when the last sessionIdle event is fired for the specified IdleStatus.
  - increaseIdleCount
```
public final void increaseIdleCount(IdleStatus status,
                     long currentTime)
```
    Increase the count of the various Idle counter
    
    参数:
    status - The current status
    currentTime - The current time
  - getBothIdleCount
```
public final int getBothIdleCount()
```
    指定者:
    
    getBothIdleCount 在接口中 IoSession
    
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.BOTH_IDLE.
    另请参阅:
    IoSession.getIdleCount(IdleStatus)
  - getLastBothIdleTime
```
public final long getLastBothIdleTime()
```
    指定者:
    
    getLastBothIdleTime 在接口中 IoSession
    
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.BOTH_IDLE.
    另请参阅:
    IoSession.getLastIdleTime(IdleStatus)
  - getLastReaderIdleTime
```
public final long getLastReaderIdleTime()
```
    指定者:
    
    getLastReaderIdleTime 在接口中 IoSession
    
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.READER_IDLE.
    另请参阅:
    IoSession.getLastIdleTime(IdleStatus)
  - getLastWriterIdleTime
```
public final long getLastWriterIdleTime()
```
    指定者:
    
    getLastWriterIdleTime 在接口中 IoSession
    
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.WRITER_IDLE.
    另请参阅:
    IoSession.getLastIdleTime(IdleStatus)
  - getReaderIdleCount
```
public final int getReaderIdleCount()
```
    指定者:
    
    getReaderIdleCount 在接口中 IoSession
    
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.READER_IDLE.
    另请参阅:
    IoSession.getIdleCount(IdleStatus)
  - getWriterIdleCount
```
public final int getWriterIdleCount()
```
    指定者:
    
    getWriterIdleCount 在接口中 IoSession
    
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.WRITER_IDLE.
    另请参阅:
    IoSession.getIdleCount(IdleStatus)
  - getServiceAddress
```
public java.net.SocketAddress getServiceAddress()
```
    指定者:
    
    getServiceAddress 在接口中 IoSession
    
    返回:
    the socket address of the IoService listens to to manage this session. If this session is managed by IoAcceptor, it returns the SocketAddress which is specified as a parameter of IoAcceptor.bind(). If this session is managed by IoConnector, this method returns the same address with that of IoSession.getRemoteAddress().
  - hashCode
```
public final int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public final boolean equals(java.lang.Object o)
```
    TODO This is a ridiculous implementation. Need to be replaced.
    
    覆盖:
    
    equals 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getService
```
public IoService getService()
```
    指定者:
    
    getService 在接口中 IoSession
    
    返回:
    the IoService which provides I/O service to this session.
  - notifyIdleness
```
public static void notifyIdleness(java.util.Iterator<? extends IoSession> sessions,
                  long currentTime)
```
    Fires a IoEventType.SESSION_IDLE event to any applicable sessions in the specified collection.
    
    参数:
    sessions - The sessions that are notified
    currentTime - the current time (i.e. System.currentTimeMillis())
  - notifyIdleSession
```
public static void notifyIdleSession(IoSession session,
                     long currentTime)
```
    Fires a IoEventType.SESSION_IDLE event if applicable for the specified session.
    
    参数:
    session - The session that is notified
    currentTime - the current time (i.e. System.currentTimeMillis())

类 AbstractIoSession

字段概要

构造器概要

方法概要

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

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

字段详细资料

config

构造器详细资料

AbstractIoSession

方法详细资料

getId

getProcessor

isConnected

isActive

isClosing

isSecured

getCloseFuture

isScheduledForFlush

scheduledForFlush

unscheduledForFlush

setScheduledForFlush

close

close

closeOnFlush

closeNow

getHandler

getConfig

read

offerReadFuture

offerFailedReadFuture

offerClosedReadFuture

write

write

getAttachment

setAttachment

getAttribute

getAttribute

setAttribute

setAttribute

setAttributeIfAbsent

setAttributeIfAbsent

removeAttribute

removeAttribute

replaceAttribute

containsAttribute

getAttributeKeys

getAttributeMap

setAttributeMap

setWriteRequestQueue

suspendRead

suspendWrite

resumeRead

resumeWrite

isReadSuspended

isWriteSuspended

getReadBytes

getWrittenBytes

getReadMessages

getWrittenMessages

getReadBytesThroughput

getWrittenBytesThroughput

getReadMessagesThroughput

getWrittenMessagesThroughput

updateThroughput

getScheduledWriteBytes

getScheduledWriteMessages

setScheduledWriteBytes

setScheduledWriteMessages

increaseReadBytes

increaseReadMessages

increaseWrittenBytes

increaseWrittenMessages

increaseScheduledWriteBytes

increaseScheduledWriteMessages

decreaseScheduledBytesAndMessages

getWriteRequestQueue

getCurrentWriteRequest

getCurrentWriteMessage

setCurrentWriteRequest