Interface IOSession
- All Superinterfaces:
AutoCloseable, ByteChannel, Channel, Closeable, Identifiable, ModalCloseable, ReadableByteChannel, SocketModalCloseable, WritableByteChannel
- All Known Subinterfaces:
ProtocolIOSession
- All Known Implementing Classes:
InternalDataChannel, 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.
- Since:
- 4.0
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThis enum represents a set of states I/O session transitions through during its life-span. -
Method Summary
Modifier and TypeMethodDescriptionchannel()Returns the underlying I/O channel associated with this session.voidclearEvent(int op) Clears interest in a particular I/O event type by updating the event mask associated with the session.voidclose()Terminates the session gracefully and closes the underlying I/O channel.voidenqueue(Command command, Command.Priority priority) InsertsCommandat the end of the command queue.intReturns mask of I/O evens this session declared interest in.Returns event handler associated with the session.default longReturns the absolute millisecond timestamp of the session initiation.longReturns the absolute millisecond timestamp of the last I/O event including socket timeout reset.longReturns the absolute millisecond timestamp of the last read event.longReturns the absolute millisecond timestamp of the last write event.Returns local address.getLock()Returns session lock that should be used by I/O event handlers to synchronize access to the session.default intReturns the number of pending commands enqueued for execution, or-1if unknown.Returns address of the remote peer.Returns value of the socket timeout in milliseconds.Returns status of the session:booleanTests if there enqueued commands pending execution.poll()Removes firstCommandfrom the command queue if available.voidsetEvent(int op) Declares interest in a particular I/O event type by updating the event mask associated with the session.voidsetEventMask(int ops) Declares interest in I/O event notifications by setting the event mask associated with the sessionvoidsetSocketTimeout(Timeout timeout) Sets value of the socket timeout in milliseconds.voidUpdates the timestamp of the last read eventvoidUpdates the timestamp of the last write eventvoidupgrade(IOEventHandler handler) Upgrades event handler associated with the session.Methods inherited from interface Identifiable
getIdMethods inherited from interface ModalCloseable
closeMethods inherited from interface ReadableByteChannel
readMethods inherited from interface WritableByteChannel
write
-
Method Details
-
getHandler
IOEventHandler getHandler()Returns event handler associated with the session.- Returns:
- the event handler, or
nullif no handler is associated with the session. - Since:
- 5.0
-
upgrade
-
getLock
Lock getLock()Returns session lock that should be used by I/O event handlers to synchronize access to the session.- Since:
- 5.0
-
enqueue
InsertsCommandat the end of the command queue.- Since:
- 5.0
-
hasCommands
boolean hasCommands()Tests if there enqueued commands pending execution.- Since:
- 5.0
-
poll
-
channel
ByteChannel channel()Returns the underlying I/O channel associated with this session.- Returns:
- the I/O channel.
-
getRemoteAddress
SocketAddress getRemoteAddress()Returns address of the remote peer.- Returns:
- socket address, or
nullif unavailable.
-
getLocalAddress
SocketAddress getLocalAddress()Returns local address.- Returns:
- socket address, or
nullif unavailable.
-
getEventMask
int getEventMask()Returns mask of I/O evens this session declared interest in.- Returns:
- I/O event mask.
-
setEventMask
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.
-
setEvent
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.
-
clearEvent
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.
-
close
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. -
getStatus
IOSession.Status getStatus()Returns status of the session:IOSession.Status.ACTIVE: session is active.IOSession.Status.CLOSING: session is being closed.IOSession.Status.CLOSED: session has been terminated.- Returns:
- session status.
-
getSocketTimeout
Timeout getSocketTimeout()Returns value of the socket timeout in milliseconds. The value of0signifies the session cannot time out.- Specified by:
getSocketTimeoutin interfaceSocketModalCloseable- Returns:
- socket timeout.
-
setSocketTimeout
Sets value of the socket timeout in milliseconds. The value of0signifies the session cannot time out.Please note this operation may affect the last event time.
- Specified by:
setSocketTimeoutin interfaceSocketModalCloseable- Parameters:
timeout- socket timeout.- See Also:
-
getInitiationTime
default long getInitiationTime()Returns the absolute millisecond timestamp of the session initiation.- Since:
- 5.5
-
getLastReadTime
long getLastReadTime()Returns the absolute millisecond timestamp of the last read event.- Returns:
- timestamp in milliseconds, compatible with
System.currentTimeMillis().
-
getLastWriteTime
long getLastWriteTime()Returns the absolute millisecond timestamp of the last write event.- Returns:
- timestamp in milliseconds, compatible with
System.currentTimeMillis().
-
getLastEventTime
long getLastEventTime()Returns the absolute millisecond timestamp of the last I/O event including socket timeout reset.- Returns:
- timestamp in milliseconds, compatible with
System.currentTimeMillis(). - See Also:
-
updateReadTime
void updateReadTime()Updates the timestamp of the last read event -
updateWriteTime
void updateWriteTime()Updates the timestamp of the last write event -
getPendingCommandCount
default int getPendingCommandCount()Returns the number of pending commands enqueued for execution, or-1if unknown.- Since:
- 5.5
-