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

所有已知子接口:

SerialSession

所有已知实现类:

AbstractIoSession, AprSession, DummySession, NioSession, ProtocolCodecSession
```
public interface IoSession
```
A handle which represents connection between two end-points regardless of transport types.

IoSession provides user-defined attributes. User-defined attributes are application-specific data which are associated with a session. It often contains objects that represents the state of a higher-level protocol and becomes a way to exchange data between filters and handlers.

Adjusting Transport Type Specific Properties

You can simply downcast the session to an appropriate subclass.

Thread Safety

IoSession is thread-safe. But please note that performing more than one write(Object) calls at the same time will cause the IoFilter.filterWrite(IoFilter.NextFilter,IoSession,WriteRequest) to be executed simultaneously, and therefore you have to make sure the IoFilter implementations you're using are thread-safe, too.

Equality of Sessions
TODO : The getId() method is totally wrong. We can't base a method which is designed to create a unique ID on the hashCode method. Object.equals(Object) and Object.hashCode() shall not be overriden to the default behavior that is defined in Object.

作者:

Apache MINA Project

方法概要

方法
限定符和类型	方法和说明
`CloseFuture`	`close()` 已过时。 use `close(boolean)`
`CloseFuture`	`close(boolean immediately)` 已过时。 Use either the closeNow() or the flushAndClose() methods
`CloseFuture`	`closeNow()` Closes this session immediately.
`CloseFuture`	`closeOnFlush()` Closes this session after all queued write requests are flushed.
`boolean`	`containsAttribute(java.lang.Object key)`
`java.lang.Object`	`getAttachment()` 已过时。 Use `getAttribute(Object)` instead.
`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()`
`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`.
`IoFilterChain`	`getFilterChain()`
`IoHandler`	`getHandler()`
`long`	`getId()`
`int`	`getIdleCount(IdleStatus status)`
`long`	`getLastBothIdleTime()`
`long`	`getLastIdleTime(IdleStatus status)`
`long`	`getLastIoTime()`
`long`	`getLastReaderIdleTime()`
`long`	`getLastReadTime()`
`long`	`getLastWriterIdleTime()`
`long`	`getLastWriteTime()`
`java.net.SocketAddress`	`getLocalAddress()`
`long`	`getReadBytes()`
`double`	`getReadBytesThroughput()`
`int`	`getReaderIdleCount()`
`long`	`getReadMessages()`
`double`	`getReadMessagesThroughput()`
`java.net.SocketAddress`	`getRemoteAddress()`
`long`	`getScheduledWriteBytes()`
`int`	`getScheduledWriteMessages()`
`IoService`	`getService()`
`java.net.SocketAddress`	`getServiceAddress()`
`TransportMetadata`	`getTransportMetadata()`
`WriteRequestQueue`	`getWriteRequestQueue()` Get the queue that contains the message waiting for being written.
`int`	`getWriterIdleCount()`
`long`	`getWrittenBytes()`
`double`	`getWrittenBytesThroughput()`
`long`	`getWrittenMessages()`
`double`	`getWrittenMessagesThroughput()`
`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`	`isSecured()`
`boolean`	`isWriterIdle()`
`boolean`	`isWriteSuspended()` Is write operation is suspended for this session.
`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.
`java.lang.Object`	`setAttachment(java.lang.Object attachment)` 已过时。 Use `setAttribute(Object, Object)` instead.
`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`	`setCurrentWriteRequest(WriteRequest currentWriteRequest)` Associate the current write request with the session
`void`	`suspendRead()` Suspends read operations for this session.
`void`	`suspendWrite()` Suspends write operations for this session.
`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 destination)` (Optional) Writes the specified `message` to the specified `destination`.

- 方法详细资料
  - getId
```
long getId()
```
    返回:
    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.
  - getService
```
IoService getService()
```
    返回:
    the IoService which provides I/O service to this session.
  - getHandler
```
IoHandler getHandler()
```
    返回:
    the IoHandler which handles this session.
  - getConfig
```
IoSessionConfig getConfig()
```
    返回:
    the configuration of this session.
  - getFilterChain
```
IoFilterChain getFilterChain()
```
    返回:
    the filter chain that only affects this session.
  - getWriteRequestQueue
```
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.
    
    返回:
    The queue containing the pending messages.
  - getTransportMetadata
```
TransportMetadata getTransportMetadata()
```
    返回:
    the TransportMetadata that this session runs on.
  - read
```
ReadFuture read()
```
    TODO This javadoc is wrong. The return tag should be short.
    
    返回:
    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 read() once you enabled this operation. To enable this operation, please call IoSessionConfig.setUseReadOperation(boolean) with true.
    
    抛出:
    
    java.lang.IllegalStateException - if useReadOperation option has not been enabled.
  - write
```
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.
    
    参数:
    message - The message to write
    
    返回:
    The associated WriteFuture
  - write
```
WriteFuture write(java.lang.Object message,
                java.net.SocketAddress destination)
```
    (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 write(Object, SocketAddress) method so you can specify the destination.
    
    参数:
    message - The message to write
    destination - null if you want the message sent to the default remote address
    
    返回:
    The associated WriteFuture
  - close
```
CloseFuture close(boolean immediately)
```
    已过时。 Use either the closeNow() or the flushAndClose() methods
    
    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.
    
    参数:
    immediately - 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
  - closeNow
```
CloseFuture closeNow()
```
    Closes this session immediately. This operation is asynchronous, it returns a CloseFuture.
  - closeOnFlush
```
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.
    
    返回:
    The associated CloseFuture
  - close
```
@Deprecated
CloseFuture close()
```
    已过时。 use close(boolean)
    
    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.
    
    返回:
    The associated CloseFuture
  - getAttachment
```
@Deprecated
java.lang.Object getAttachment()
```
    已过时。 Use getAttribute(Object) instead.
    
    Returns an attachment of this session. This method is identical with getAttribute( "" ).
    
    返回:
    The attachment
  - setAttachment
```
@Deprecated
java.lang.Object setAttachment(java.lang.Object attachment)
```
    已过时。 Use setAttribute(Object, Object) instead.
    
    Sets an attachment of this session. This method is identical with setAttribute( "", attachment ).
    
    参数:
    attachment - The attachment
    
    返回:
    Old attachment. null if it is new.
  - getAttribute
```
java.lang.Object getAttribute(java.lang.Object key)
```
    Returns the value of the user-defined attribute of this session.
    
    参数:
    key - the key of the attribute
    
    返回:
    null if there is no attribute with the specified key
  - getAttribute
```
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;
 }
 
```
    参数:
    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
```
java.lang.Object setAttribute(java.lang.Object key,
                            java.lang.Object value)
```
    Sets a user-defined attribute.
    
    参数:
    key - the key of the attribute
    value - the value of the attribute
    
    返回:
    The old value of the attribute. null if it is new.
  - setAttribute
```
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.
    
    参数:
    key - the key of the attribute
    
    返回:
    The old value of the attribute. null if it is new.
  - setAttributeIfAbsent
```
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);
 }
 
```
    参数:
    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
```
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);
 }
 
```
    参数:
    key - The key of the attribute we want to set
    
    返回:
    The old value of the attribute. null if not found.
  - removeAttribute
```
java.lang.Object removeAttribute(java.lang.Object key)
```
    Removes a user-defined attribute with the specified key.
    
    参数:
    key - The key of the attribute we want to remove
    
    返回:
    The old value of the attribute. null if not found.
  - removeAttribute
```
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;
 }
 
```
    参数:
    key - The key we want to remove
    value - The value we want to remove
    
    返回:
    true if the removal was successful
  - replaceAttribute
```
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;
 }
 
```
    参数:
    key - The key we want to replace
    oldValue - The previous value
    newValue - The new value
    
    返回:
    true if the replacement was successful
  - containsAttribute
```
boolean containsAttribute(java.lang.Object key)
```
    参数:
    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
```
java.util.Set<java.lang.Object> getAttributeKeys()
```
    返回:
    the set of keys of all user-defined attributes.
  - isConnected
```
boolean isConnected()
```
    返回:
    true if this session is connected with remote peer.
  - isActive
```
boolean isActive()
```
    返回:
    true if this session is active.
  - isClosing
```
boolean isClosing()
```
    返回:
    true if and only if this session is being closed (but not disconnected yet) or is closed.
  - isSecured
```
boolean isSecured()
```
    返回:
    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
```
CloseFuture getCloseFuture()
```
    返回:
    the CloseFuture of this session. This method returns the same instance whenever user calls it.
  - getRemoteAddress
```
java.net.SocketAddress getRemoteAddress()
```
    返回:
    the socket address of remote peer.
  - getLocalAddress
```
java.net.SocketAddress getLocalAddress()
```
    返回:
    the socket address of local machine which is associated with this session.
  - getServiceAddress
```
java.net.SocketAddress getServiceAddress()
```
    返回:
    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 getRemoteAddress().
  - setCurrentWriteRequest
```
void setCurrentWriteRequest(WriteRequest currentWriteRequest)
```
    Associate the current write request with the session
    
    参数:
    currentWriteRequest - the current write request to associate
  - suspendRead
```
void suspendRead()
```
    Suspends read operations for this session.
  - suspendWrite
```
void suspendWrite()
```
    Suspends write operations for this session.
  - resumeRead
```
void resumeRead()
```
    Resumes read operations for this session.
  - resumeWrite
```
void resumeWrite()
```
    Resumes write operations for this session.
  - isReadSuspended
```
boolean isReadSuspended()
```
    Is read operation is suspended for this session.
    
    返回:
    true if suspended
  - isWriteSuspended
```
boolean isWriteSuspended()
```
    Is write operation is suspended for this session.
    
    返回:
    true if suspended
  - updateThroughput
```
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.
    
    参数:
    currentTime - the current time in milliseconds
    force - Force the update if true
  - getReadBytes
```
long getReadBytes()
```
    返回:
    the total number of bytes which were read from this session.
  - getWrittenBytes
```
long getWrittenBytes()
```
    返回:
    the total number of bytes which were written to this session.
  - getReadMessages
```
long getReadMessages()
```
    返回:
    the total number of messages which were read and decoded from this session.
  - getWrittenMessages
```
long getWrittenMessages()
```
    返回:
    the total number of messages which were written and encoded by this session.
  - getReadBytesThroughput
```
double getReadBytesThroughput()
```
    返回:
    the number of read bytes per second.
  - getWrittenBytesThroughput
```
double getWrittenBytesThroughput()
```
    返回:
    the number of written bytes per second.
  - getReadMessagesThroughput
```
double getReadMessagesThroughput()
```
    返回:
    the number of read messages per second.
  - getWrittenMessagesThroughput
```
double getWrittenMessagesThroughput()
```
    返回:
    the number of written messages per second.
  - getScheduledWriteMessages
```
int getScheduledWriteMessages()
```
    返回:
    the number of messages which are scheduled to be written to this session.
  - getScheduledWriteBytes
```
long getScheduledWriteBytes()
```
    返回:
    the number of bytes which are scheduled to be written to this session.
  - getCurrentWriteMessage
```
java.lang.Object getCurrentWriteMessage()
```
    Returns the message which is being written by IoService.
    
    返回:
    null if and if only no message is being written
  - getCurrentWriteRequest
```
WriteRequest getCurrentWriteRequest()
```
    Returns the WriteRequest which is being processed by IoService.
    
    返回:
    null if and if only no message is being written
  - getCreationTime
```
long getCreationTime()
```
    返回:
    the session's creation time in milliseconds
  - getLastIoTime
```
long getLastIoTime()
```
    返回:
    the time in millis when I/O occurred lastly.
  - getLastReadTime
```
long getLastReadTime()
```
    返回:
    the time in millis when read operation occurred lastly.
  - getLastWriteTime
```
long getLastWriteTime()
```
    返回:
    the time in millis when write operation occurred lastly.
  - isIdle
```
boolean isIdle(IdleStatus status)
```
    参数:
    status - The researched idle status
    
    返回:
    true if this session is idle for the specified IdleStatus.
  - isReaderIdle
```
boolean isReaderIdle()
```
    返回:
    true if this session is IdleStatus.READER_IDLE.
    另请参阅:
    isIdle(IdleStatus)
  - isWriterIdle
```
boolean isWriterIdle()
```
    返回:
    true if this session is IdleStatus.WRITER_IDLE.
    另请参阅:
    isIdle(IdleStatus)
  - isBothIdle
```
boolean isBothIdle()
```
    返回:
    true if this session is IdleStatus.BOTH_IDLE.
    另请参阅:
    isIdle(IdleStatus)
  - getIdleCount
```
int getIdleCount(IdleStatus status)
```
    参数:
    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.
  - getReaderIdleCount
```
int getReaderIdleCount()
```
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.READER_IDLE.
    另请参阅:
    getIdleCount(IdleStatus)
  - getWriterIdleCount
```
int getWriterIdleCount()
```
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.WRITER_IDLE.
    另请参阅:
    getIdleCount(IdleStatus)
  - getBothIdleCount
```
int getBothIdleCount()
```
    返回:
    the number of the fired continuous sessionIdle events for IdleStatus.BOTH_IDLE.
    另请参阅:
    getIdleCount(IdleStatus)
  - getLastIdleTime
```
long getLastIdleTime(IdleStatus status)
```
    参数:
    status - The researched idle status
    
    返回:
    the time in milliseconds when the last sessionIdle event is fired for the specified IdleStatus.
  - getLastReaderIdleTime
```
long getLastReaderIdleTime()
```
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.READER_IDLE.
    另请参阅:
    getLastIdleTime(IdleStatus)
  - getLastWriterIdleTime
```
long getLastWriterIdleTime()
```
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.WRITER_IDLE.
    另请参阅:
    getLastIdleTime(IdleStatus)
  - getLastBothIdleTime
```
long getLastBothIdleTime()
```
    返回:
    the time in milliseconds when the last sessionIdle event is fired for IdleStatus.BOTH_IDLE.
    另请参阅:
    getLastIdleTime(IdleStatus)

接口 IoSession

Adjusting Transport Type Specific Properties

Thread Safety

Equality of Sessions

方法概要

方法详细资料

getId

getService

getHandler

getConfig

getFilterChain

getWriteRequestQueue

getTransportMetadata

read

write

write

close

closeNow

closeOnFlush

close

getAttachment

setAttachment

getAttribute

getAttribute

setAttribute

setAttribute

setAttributeIfAbsent

setAttributeIfAbsent

removeAttribute

removeAttribute

replaceAttribute

containsAttribute

getAttributeKeys

isConnected

isActive

isClosing

isSecured

getCloseFuture

getRemoteAddress

getLocalAddress

getServiceAddress

setCurrentWriteRequest

suspendRead

suspendWrite

resumeRead

resumeWrite

isReadSuspended

isWriteSuspended

updateThroughput

getReadBytes

getWrittenBytes

getReadMessages

getWrittenMessages

getReadBytesThroughput

getWrittenBytesThroughput

getReadMessagesThroughput

getWrittenMessagesThroughput

getScheduledWriteMessages

getScheduledWriteBytes

getCurrentWriteMessage

getCurrentWriteRequest

getCreationTime

getLastIoTime

getLastReadTime

getLastWriteTime

isIdle

isReaderIdle

isWriterIdle

isBothIdle

getIdleCount

getReaderIdleCount

getWriterIdleCount

getBothIdleCount

getLastIdleTime

getLastReaderIdleTime

getLastWriterIdleTime

getLastBothIdleTime