Save This Page
Home » HttpComponents-Core-4.0.1 » org.apache.http.nio.reactor » [javadoc | source]
org.apache.http.nio.reactor
public interface: IOSession [javadoc | source]

All Known Implementing Classes:
    LoggingIOSession, IOSessionImpl, SSLIOSession

IOSession interface represents a sequence of logically related data exchanges between two end points.

The channel associated with implementations of this interface can be used to read data from and write data to the session.

I/O sessions are not bound to an execution thread, therefore one cannot use the context of the thread to store a session's state. All details about a particular session must be stored within the session itself, usually using execution context associated with it.

Implementations of this interface are expected to be threading safe.

Field Summary
public static final  String ATTACHMENT_KEY    Name of the context attribute key, which can be used to obtain the session attachment object. 
public static final  int ACTIVE     
public static final  int CLOSING     
public static final  int CLOSED     
Method from org.apache.http.nio.reactor.IOSession Summary:
channel,   clearEvent,   close,   getAttribute,   getEventMask,   getLocalAddress,   getRemoteAddress,   getSocketTimeout,   getStatus,   hasBufferedInput,   hasBufferedOutput,   isClosed,   removeAttribute,   setAttribute,   setBufferStatus,   setEvent,   setEventMask,   setSocketTimeout,   shutdown
Method from org.apache.http.nio.reactor.IOSession Detail:
 public ByteChannel channel()
    Returns the underlying I/O channel associated with this session.
 public  void clearEvent(int op)
    Clears interest in a particular I/O event type by updating the event mask associated with the session.
 public  void close()
    Terminates the session gracefully and closes the underlying I/O channel. This method ensures that session termination handshake, such as the one used by the SSL/TLS protocol, is correctly carried out.
 public Object getAttribute(String name)
    Returns the value of the attribute with the given name. The value can be null if not set.

    The value of the session attachment object can be obtained using #ATTACHMENT_KEY name.

 public int getEventMask()
    Returns mask of I/O evens this session declared interest in.
 public SocketAddress getLocalAddress()
    Returns local address.
 public SocketAddress getRemoteAddress()
    Returns address of the remote peer.
 public int getSocketTimeout()
    Returns value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
 public int getStatus()
    Returns status of the session:

    #ACTIVE : session is active.

    #CLOSING : session is being closed.

    #CLOSED : session has been terminated.

 public boolean hasBufferedInput()
    Determines if the input buffer associated with the session contains data.
 public boolean hasBufferedOutput()
    Determines if the output buffer associated with the session contains data.
 public boolean isClosed()
    Determines if the session has been terminated.
 public Object removeAttribute(String name)
    Removes attribute with the given name.
 public  void setAttribute(String name,
    Object obj)
    This method can be used to associate a particular object with the session by the given attribute name.

    I/O sessions are not bound to an execution thread, therefore one cannot use the context of the thread to store a session's state. All details about a particular session must be stored within the session itself.

 public  void setBufferStatus(SessionBufferStatus status)
    Quite often I/O sessions need to maintain internal I/O buffers in order to transform input / output data prior to returning it to the consumer or writing it to the underlying channel. Memory management in HttpCore NIO is based on the fundamental principle that the data consumer can read only as much input data as it can process without having to allocate more memory. That means, quite often some input data may remain unread in one of the internal or external session buffers. The I/O reactor can query the status of these session buffers, and make sure the consumer gets notified correctly as more data gets stored in one of the session buffers, thus allowing the consumer to read the remaining data once it is able to process it

    I/O sessions can be made aware of the status of external session buffers using the SessionBufferStatus interface.

 public  void setEvent(int op)
    Declares interest in a particular I/O event type by updating the event mask associated with the session.
 public  void setEventMask(int ops)
    Declares interest in I/O event notifications by setting the event mask associated with the session
 public  void setSocketTimeout(int timeout)
    Sets value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
 public  void shutdown()
    Terminates the session by shutting down the underlying I/O channel.