public interface

IOSession

org.apache.http.nio.reactor.IOSession
Known Indirect Subclasses

Class Overview

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.

Summary

Constants
int ACTIVE
String ATTACHMENT_KEY Name of the context attribute key, which can be used to obtain the session attachment object.
int CLOSED
int CLOSING
Public Methods
abstract ByteChannel channel()
Returns the underlying I/O channel associated with this session.
abstract void clearEvent(int op)
Clears interest in a particular I/O event type by updating the event mask associated with the session.
abstract void close()
Terminates the session gracefully and closes the underlying I/O channel.
abstract Object getAttribute(String name)
Returns the value of the attribute with the given name.
abstract int getEventMask()
Returns mask of I/O evens this session declared interest in.
abstract SocketAddress getLocalAddress()
Returns local address.
abstract SocketAddress getRemoteAddress()
Returns address of the remote peer.
abstract int getSocketTimeout()
Returns value of the socket timeout in milliseconds.
abstract int getStatus()
Returns status of the session:

ACTIVE: session is active.

abstract boolean hasBufferedInput()
Determines if the input buffer associated with the session contains data.
abstract boolean hasBufferedOutput()
Determines if the output buffer associated with the session contains data.
abstract boolean isClosed()
Determines if the session has been terminated.
abstract Object removeAttribute(String name)
Removes attribute with the given name.
abstract void setAttribute(String name, Object obj)
This method can be used to associate a particular object with the session by the given attribute name.
abstract 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.
abstract void setEvent(int op)
Declares interest in a particular I/O event type by updating the event mask associated with the session.
abstract void setEventMask(int ops)
Declares interest in I/O event notifications by setting the event mask associated with the session
abstract void setSocketTimeout(int timeout)
Sets value of the socket timeout in milliseconds.
abstract void shutdown()
Terminates the session by shutting down the underlying I/O channel.

Constants

public static final int ACTIVE

Constant Value: 0 (0x00000000)

public static final String ATTACHMENT_KEY

Name of the context attribute key, which can be used to obtain the session attachment object.

Constant Value: "http.session.attachment"

public static final int CLOSED

Constant Value: 2147483647 (0x7fffffff)

public static final int CLOSING

Constant Value: 1 (0x00000001)

Public Methods

public abstract ByteChannel channel ()

Returns the underlying I/O channel associated with this session.

Returns
  • the I/O channel.

public abstract void clearEvent (int op)

Clears interest in a particular I/O event type by updating the event mask associated with the session.

Parameters
op I/O event type.

public abstract 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 abstract 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.

Parameters
name name of the attribute.
Returns
  • value of the attribute.

public abstract int getEventMask ()

Returns mask of I/O evens this session declared interest in.

Returns
  • I/O event mask.

public abstract SocketAddress getLocalAddress ()

Returns local address.

Returns
  • socket address.

public abstract SocketAddress getRemoteAddress ()

Returns address of the remote peer.

Returns
  • socket address.

public abstract int getSocketTimeout ()

Returns value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.

Returns
  • socket timeout.

public abstract int getStatus ()

Returns status of the session:

ACTIVE: session is active.

CLOSING: session is being closed.

CLOSED: session has been terminated.

Returns
  • session status.

public abstract boolean hasBufferedInput ()

Determines if the input buffer associated with the session contains data.

Returns
  • true if the session input buffer contains data, false otherwise.

public abstract boolean hasBufferedOutput ()

Determines if the output buffer associated with the session contains data.

Returns
  • true if the session output buffer contains data, false otherwise.

public abstract boolean isClosed ()

Determines if the session has been terminated.

Returns
  • true if the session has been terminated, false otherwise.

public abstract Object removeAttribute (String name)

Removes attribute with the given name.

Parameters
name name of the attribute to be removed.
Returns
  • value of the removed attribute.

public abstract 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.

Parameters
name name of the attribute.
obj value of the attribute.

public abstract 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 abstract void setEvent (int op)

Declares interest in a particular I/O event type by updating the event mask associated with the session.

Parameters
op I/O event type.

public abstract void setEventMask (int ops)

Declares interest in I/O event notifications by setting the event mask associated with the session

Parameters
ops new I/O event mask.

public abstract void setSocketTimeout (int timeout)

Sets value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.

Parameters
timeout socket timeout.

public abstract void shutdown ()

Terminates the session by shutting down the underlying I/O channel.