Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.reactor.ssl.SSLIOSession

Modifier and Type	Class and Description
pack-priv static enum	SSLIOSession.TLSHandShakeState

Modifier and Type	Field and Description
private int	appEventMask
private static final ByteBuffer	EMPTY_BUFFER
private volatile boolean	endOfStream
private final AtomicReference<FutureCallback<SSLSession>>	handshakeCallbackRef
private final AtomicReference<SSLIOSession.TLSHandShakeState>	handshakeStateRef
private final Timeout	handshakeTimeout
private final SSLManagedBuffer	inEncrypted
private final SSLSessionInitializer	initializer
private final SSLManagedBuffer	inPlain
private final IOEventHandler	internalEventHandler
private final AtomicInteger	outboundClosedCount
private final SSLManagedBuffer	outEncrypted
private final IOSession	session
private final Callback<SSLIOSession>	sessionEndCallback
private final Callback<SSLIOSession>	sessionStartCallback
private volatile Timeout	socketTimeout
private final SSLEngine	sslEngine
private final SSLMode	sslMode
private volatile IOSession.Status	status
private final NamedEndpoint	targetEndpoint
private volatile TlsDetails	tlsDetails
private final SSLSessionVerifier	verifier

Access	Constructor and Description
public	SSLIOSession(final NamedEndpoint target endpoint (applicable in client mode only). May be `null`. targetEndpoint, final IOSession I/O session to be decorated with the TLS/SSL capabilities. session, final SSLMode SSL mode (client or server) sslMode, final SSLContext SSL context to use for this I/O session. sslContext, final SSLBufferMode buffer management mode sslBufferMode, final SSLSessionInitializer optional SSL session initializer. May be `null`. initializer, final SSLSessionVerifier optional SSL session verifier. May be `null`. verifier, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final Timeout timeout to apply for the TLS/SSL handshake. May be `null`. connectTimeout) Creates new instance of `SSLIOSession` class.
public	SSLIOSession(final NamedEndpoint target endpoint (applicable in client mode only). May be `null`. targetEndpoint, final IOSession I/O session to be decorated with the TLS/SSL capabilities. session, final SSLMode SSL mode (client or server) sslMode, final SSLContext SSL context to use for this I/O session. sslContext, final SSLBufferMode buffer management mode sslBufferMode, final SSLSessionInitializer optional SSL session initializer. May be `null`. initializer, final SSLSessionVerifier optional SSL session verifier. May be `null`. verifier, final Timeout timeout to apply for the TLS/SSL handshake. May be `null`. handshakeTimeout, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final FutureCallback<SSLSession> result callback. May be `null`. resultCallback) Creates new instance of `SSLIOSession` class.

Method Summary

Modifier and Type	Method and Description
public void	beginHandshake(final IOSession protocolSession)
public ByteChannel	channel() Implements org.apache.hc.core5.reactor.IOSession.channel. Returns the underlying I/O channel associated with this session.
public void	clearEvent(final int I/O event type. op) Implements org.apache.hc.core5.reactor.IOSession.clearEvent. Clears interest in a particular I/O event type by updating the event mask associated with the session.
public void	close() Implements org.apache.hc.core5.reactor.IOSession.close. Terminates the session gracefully and closes the underlying I/O channel.
public void	close(final CloseMode How to close the receiver. closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it.
private SSLException	convert(final RuntimeException ex)
private void	decryptData(final IOSession protocolSession)
private void	doHandshake(final IOSession protocolSession)
private void	doRunTask()
private SSLEngineResult	doUnwrap(final ByteBuffer src, final ByteBuffer dst)
private SSLEngineResult	doWrap(final ByteBuffer src, final ByteBuffer dst)
private void	encryptData(final IOSession protocolSession)
public void	enqueue(final Command command, final Command.Priority priority) Implements org.apache.hc.core5.reactor.IOSession.enqueue. Inserts `Command` at the end of the command queue.
private IOEventHandler	ensureHandler()
private static void	formatOps(final StringBuilder buffer, final int ops)
public int	getEventMask() Implements org.apache.hc.core5.reactor.IOSession.getEventMask. Returns mask of I/O evens this session declared interest in.
public IOEventHandler	getHandler() Implements org.apache.hc.core5.reactor.IOSession.getHandler. Returns event handler associated with the session.
public String	getId() Implements org.apache.hc.core5.util.Identifiable.getId.
public long	getLastEventTime() Implements org.apache.hc.core5.reactor.IOSession.getLastEventTime. Returns timestamp of the last I/O event including socket timeout reset.
public long	getLastReadTime() Implements org.apache.hc.core5.reactor.IOSession.getLastReadTime. Returns timestamp of the last read event.
public long	getLastWriteTime() Implements org.apache.hc.core5.reactor.IOSession.getLastWriteTime. Returns timestamp of the last write event.
public SocketAddress	getLocalAddress() Implements org.apache.hc.core5.reactor.IOSession.getLocalAddress. Returns local address.
public Lock	getLock() Implements org.apache.hc.core5.reactor.IOSession.getLock. Returns session lock that should be used by I/O event handlers to synchronize access to the session.
public SocketAddress	getRemoteAddress() Implements org.apache.hc.core5.reactor.IOSession.getRemoteAddress. Returns address of the remote peer.
public Timeout	getSocketTimeout() Implements org.apache.hc.core5.reactor.IOSession.getSocketTimeout. Returns value of the socket timeout in milliseconds.
public IOSession.Status	getStatus() Implements org.apache.hc.core5.reactor.IOSession.getStatus. Returns status of the session: `Status#ACTIVE`: session is active.
public TlsDetails	getTlsDetails()
public boolean	hasCommands() Implements org.apache.hc.core5.reactor.IOSession.hasCommands. Tests if there enqueued commands pending execution.
private void	initialize(final IOSession protocolSession)
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public Command	poll() Implements org.apache.hc.core5.reactor.IOSession.poll. Removes first `Command` from the command queue if available.
public int	read(final ByteBuffer The buffer into which bytes are to be transferred dst) Implements java.nio.channels.ReadableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer.
private int	receiveEncryptedData()
private int	sendEncryptedData()
public void	setEvent(final int I/O event type. op) Implements org.apache.hc.core5.reactor.IOSession.setEvent. Declares interest in a particular I/O event type by updating the event mask associated with the session.
public void	setEventMask(final int new I/O event mask. ops) Implements org.apache.hc.core5.reactor.IOSession.setEventMask. Declares interest in I/O event notifications by setting the event mask associated with the session
public void	setSocketTimeout(final Timeout socket timeout. timeout) Implements org.apache.hc.core5.reactor.IOSession.setSocketTimeout. Sets value of the socket timeout in milliseconds.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	updateEventMask()
public void	updateReadTime() Implements org.apache.hc.core5.reactor.IOSession.updateReadTime. Updates the timestamp of the last read event
public void	updateWriteTime() Implements org.apache.hc.core5.reactor.IOSession.updateWriteTime. Updates the timestamp of the last write event
public void	upgrade(final IOEventHandler handler) Implements org.apache.hc.core5.reactor.IOSession.upgrade. Upgrades event handler associated with the session.
public int	write(final ByteBuffer The buffer from which bytes are to be retrieved src) Implements java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

appEventMask	back to summary
private int appEventMask

EMPTY_BUFFER	back to summary
private static final ByteBuffer EMPTY_BUFFER

endOfStream	back to summary
private volatile boolean endOfStream

handshakeCallbackRef	back to summary
private final AtomicReference<FutureCallback<SSLSession>> handshakeCallbackRef

handshakeStateRef	back to summary
private final AtomicReference<SSLIOSession.TLSHandShakeState> handshakeStateRef

handshakeTimeout	back to summary
private final Timeout handshakeTimeout

inEncrypted	back to summary
private final SSLManagedBuffer inEncrypted

initializer	back to summary
private final SSLSessionInitializer initializer

inPlain	back to summary
private final SSLManagedBuffer inPlain

internalEventHandler	back to summary
private final IOEventHandler internalEventHandler

outboundClosedCount	back to summary
private final AtomicInteger outboundClosedCount

outEncrypted	back to summary
private final SSLManagedBuffer outEncrypted

session	back to summary
private final IOSession session

sessionEndCallback	back to summary
private final Callback<SSLIOSession> sessionEndCallback

sessionStartCallback	back to summary
private final Callback<SSLIOSession> sessionStartCallback

socketTimeout	back to summary
private volatile Timeout socketTimeout

sslEngine	back to summary
private final SSLEngine sslEngine

sslMode	back to summary
private final SSLMode sslMode

status	back to summary
private volatile IOSession.Status status

targetEndpoint	back to summary
private final NamedEndpoint targetEndpoint

tlsDetails	back to summary
private volatile TlsDetails tlsDetails

verifier	back to summary
private final SSLSessionVerifier verifier

Constructor Detail

SSLIOSession back to summary

SSLIOSession	back to summary
public SSLIOSession(final NamedEndpoint targetEndpoint, final IOSession session, final SSLMode sslMode, final SSLContext sslContext, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final Timeout connectTimeout) Creates new instance of `SSLIOSession` class. Parameters targetEndpoint:NamedEndpoint target endpoint (applicable in client mode only). May be `null`. session:IOSession I/O session to be decorated with the TLS/SSL capabilities. sslMode:SSLMode SSL mode (client or server) sslContext:SSLContext SSL context to use for this I/O session. sslBufferMode:SSLBufferMode buffer management mode initializer:SSLSessionInitializer optional SSL session initializer. May be `null`. verifier:SSLSessionVerifier optional SSL session verifier. May be `null`. connectTimeout:Timeout timeout to apply for the TLS/SSL handshake. May be `null`. Since 5.0

public SSLIOSession(final NamedEndpoint targetEndpoint, final IOSession session, final SSLMode sslMode, final SSLContext sslContext, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final Timeout connectTimeout)

Creates new instance of SSLIOSession class.

Parameters

targetEndpoint:NamedEndpoint: target endpoint (applicable in client mode only). May be null.
session:IOSession: I/O session to be decorated with the TLS/SSL capabilities.
sslMode:SSLMode: SSL mode (client or server)
sslContext:SSLContext: SSL context to use for this I/O session.
sslBufferMode:SSLBufferMode: buffer management mode
initializer:SSLSessionInitializer: optional SSL session initializer. May be null.
verifier:SSLSessionVerifier: optional SSL session verifier. May be null.
connectTimeout:Timeout: timeout to apply for the TLS/SSL handshake. May be null.

Since

5.0

SSLIOSession back to summary

SSLIOSession	back to summary
public SSLIOSession(final NamedEndpoint targetEndpoint, final IOSession session, final SSLMode sslMode, final SSLContext sslContext, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final FutureCallback<SSLSession> resultCallback) Creates new instance of `SSLIOSession` class. Parameters targetEndpoint:NamedEndpoint target endpoint (applicable in client mode only). May be `null`. session:IOSession I/O session to be decorated with the TLS/SSL capabilities. sslMode:SSLMode SSL mode (client or server) sslContext:SSLContext SSL context to use for this I/O session. sslBufferMode:SSLBufferMode buffer management mode initializer:SSLSessionInitializer optional SSL session initializer. May be `null`. verifier:SSLSessionVerifier optional SSL session verifier. May be `null`. handshakeTimeout:Timeout timeout to apply for the TLS/SSL handshake. May be `null`. resultCallback:FutureCallback<SSLSession> result callback. May be `null`. Since 5.2

public SSLIOSession(final NamedEndpoint targetEndpoint, final IOSession session, final SSLMode sslMode, final SSLContext sslContext, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout, final Callback<SSLIOSession> sessionStartCallback, final Callback<SSLIOSession> sessionEndCallback, final FutureCallback<SSLSession> resultCallback)

Creates new instance of SSLIOSession class.

Parameters

targetEndpoint:NamedEndpoint: target endpoint (applicable in client mode only). May be null.
session:IOSession: I/O session to be decorated with the TLS/SSL capabilities.
sslMode:SSLMode: SSL mode (client or server)
sslContext:SSLContext: SSL context to use for this I/O session.
sslBufferMode:SSLBufferMode: buffer management mode
initializer:SSLSessionInitializer: optional SSL session initializer. May be null.
verifier:SSLSessionVerifier: optional SSL session verifier. May be null.
handshakeTimeout:Timeout: timeout to apply for the TLS/SSL handshake. May be null.
resultCallback:FutureCallback<SSLSession>: result callback. May be null.

Since

5.2

Method Detail

beginHandshake	back to summary
public void beginHandshake(final IOSession protocolSession) throws IOException

channel	back to summary
public ByteChannel channel() Implements org.apache.hc.core5.reactor.IOSession.channel. Doc from org.apache.hc.core5.reactor.IOSession.channel. Returns the underlying I/O channel associated with this session. Returns:ByteChannel the I/O channel. Annotations @Override

channel

back to summary

public ByteChannel channel()

Implements org.apache.hc.core5.reactor.IOSession.channel.

Doc from org.apache.hc.core5.reactor.IOSession.channel.

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

Returns:ByteChannel

the I/O channel.

Annotations

@Override

clearEvent	back to summary
public void clearEvent(final int op) Implements org.apache.hc.core5.reactor.IOSession.clearEvent. Doc from org.apache.hc.core5.reactor.IOSession.clearEvent. Clears interest in a particular I/O event type by updating the event mask associated with the session. Parameters op:int I/O event type. Annotations @Override

clearEvent

back to summary

public void clearEvent(final int op)

Implements org.apache.hc.core5.reactor.IOSession.clearEvent.

Doc from org.apache.hc.core5.reactor.IOSession.clearEvent.

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

Parameters

op:int: I/O event type.

Annotations

@Override

close	back to summary
public void close() Implements org.apache.hc.core5.reactor.IOSession.close. Doc from org.apache.hc.core5.reactor.IOSession.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. Annotations @Override

back to summary

public void close()

Implements org.apache.hc.core5.reactor.IOSession.close.

Doc from org.apache.hc.core5.reactor.IOSession.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.

Annotations

@Override

close	back to summary
public void close(final CloseMode closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Doc from org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect. Parameters closeMode:CloseMode How to close the receiver. Annotations @Override

back to summary

public void close(final CloseMode closeMode)

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.

Parameters

closeMode:CloseMode: How to close the receiver.

Annotations

@Override

convert	back to summary
private SSLException convert(final RuntimeException ex)

decryptData	back to summary
private void decryptData(final IOSession protocolSession) throws IOException

doHandshake	back to summary
private void doHandshake(final IOSession protocolSession) throws IOException

doRunTask	back to summary
private void doRunTask()

doUnwrap	back to summary
private SSLEngineResult doUnwrap(final ByteBuffer src, final ByteBuffer dst) throws SSLException

doWrap	back to summary
private SSLEngineResult doWrap(final ByteBuffer src, final ByteBuffer dst) throws SSLException

encryptData	back to summary
private void encryptData(final IOSession protocolSession) throws IOException

enqueue back to summary

enqueue	back to summary
public void enqueue(final Command command, final Command.Priority priority) Implements org.apache.hc.core5.reactor.IOSession.enqueue. Doc from org.apache.hc.core5.reactor.IOSession.enqueue. Inserts `Command` at the end of the command queue. Annotations @Override

public void enqueue(final Command command, final Command.Priority priority)

Implements org.apache.hc.core5.reactor.IOSession.enqueue.

Doc from org.apache.hc.core5.reactor.IOSession.enqueue.

Inserts Command at the end of the command queue.

Annotations

@Override

ensureHandler	back to summary
private IOEventHandler ensureHandler()

formatOps	back to summary
private static void formatOps(final StringBuilder buffer, final int ops)

getEventMask	back to summary
public int getEventMask() Implements org.apache.hc.core5.reactor.IOSession.getEventMask. Doc from org.apache.hc.core5.reactor.IOSession.getEventMask. Returns mask of I/O evens this session declared interest in. Returns:int I/O event mask. Annotations @Override

getEventMask

back to summary

public int getEventMask()

Implements org.apache.hc.core5.reactor.IOSession.getEventMask.

Doc from org.apache.hc.core5.reactor.IOSession.getEventMask.

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

Returns:int

I/O event mask.

Annotations

@Override

getHandler	back to summary
public IOEventHandler getHandler() Implements org.apache.hc.core5.reactor.IOSession.getHandler. Doc from org.apache.hc.core5.reactor.IOSession.getHandler. Returns event handler associated with the session. Annotations @Override

getHandler

back to summary

public IOEventHandler getHandler()

Implements org.apache.hc.core5.reactor.IOSession.getHandler.

Doc from org.apache.hc.core5.reactor.IOSession.getHandler.

Returns event handler associated with the session.

Annotations

@Override

getId	back to summary
public String getId() Implements org.apache.hc.core5.util.Identifiable.getId. Annotations @Override

getId

back to summary

public String getId()

Implements org.apache.hc.core5.util.Identifiable.getId.

Annotations

@Override

getLastEventTime	back to summary
public long getLastEventTime() Implements org.apache.hc.core5.reactor.IOSession.getLastEventTime. Doc from org.apache.hc.core5.reactor.IOSession.getLastEventTime. Returns timestamp of the last I/O event including socket timeout reset. Returns:long timestamp. Annotations @Override

getLastEventTime

back to summary

public long getLastEventTime()

Implements org.apache.hc.core5.reactor.IOSession.getLastEventTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastEventTime.

Returns timestamp of the last I/O event including socket timeout reset.

Returns:long

timestamp.

Annotations

@Override

getLastReadTime	back to summary
public long getLastReadTime() Implements org.apache.hc.core5.reactor.IOSession.getLastReadTime. Doc from org.apache.hc.core5.reactor.IOSession.getLastReadTime. Returns timestamp of the last read event. Returns:long timestamp. Annotations @Override

getLastReadTime

back to summary

public long getLastReadTime()

Implements org.apache.hc.core5.reactor.IOSession.getLastReadTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastReadTime.

Returns timestamp of the last read event.

Returns:long

timestamp.

Annotations

@Override

getLastWriteTime	back to summary
public long getLastWriteTime() Implements org.apache.hc.core5.reactor.IOSession.getLastWriteTime. Doc from org.apache.hc.core5.reactor.IOSession.getLastWriteTime. Returns timestamp of the last write event. Returns:long timestamp. Annotations @Override

getLastWriteTime

back to summary

public long getLastWriteTime()

Implements org.apache.hc.core5.reactor.IOSession.getLastWriteTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastWriteTime.

Returns timestamp of the last write event.

Returns:long

timestamp.

Annotations

@Override

getLocalAddress	back to summary
public SocketAddress getLocalAddress() Implements org.apache.hc.core5.reactor.IOSession.getLocalAddress. Doc from org.apache.hc.core5.reactor.IOSession.getLocalAddress. Returns local address. Returns:SocketAddress socket address. Annotations @Override

getLocalAddress

back to summary

public SocketAddress getLocalAddress()

Implements org.apache.hc.core5.reactor.IOSession.getLocalAddress.

Doc from org.apache.hc.core5.reactor.IOSession.getLocalAddress.

Returns local address.

Returns:SocketAddress

socket address.

Annotations

@Override

getLock

back to summary

public Lock getLock()

Implements org.apache.hc.core5.reactor.IOSession.getLock.

Doc from org.apache.hc.core5.reactor.IOSession.getLock.

Returns session lock that should be used by I/O event handlers to synchronize access to the session.

Annotations

@Override

getRemoteAddress

back to summary

public SocketAddress getRemoteAddress()

Implements org.apache.hc.core5.reactor.IOSession.getRemoteAddress.

Doc from org.apache.hc.core5.reactor.IOSession.getRemoteAddress.

Returns address of the remote peer.

Returns:SocketAddress

socket address.

Annotations

@Override

getSocketTimeout back to summary

public Timeout getSocketTimeout()

Implements org.apache.hc.core5.reactor.IOSession.getSocketTimeout.

Doc from org.apache.hc.core5.reactor.IOSession.getSocketTimeout.

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

Returns:Timeout

socket timeout.

Annotations

@Override

getStatus back to summary

public IOSession.Status getStatus()

Implements org.apache.hc.core5.reactor.IOSession.getStatus.

Doc from org.apache.hc.core5.reactor.IOSession.getStatus.

Returns status of the session:

Status#ACTIVE: session is active.

Status#CLOSING: session is being closed.

Status#CLOSED: session has been terminated.

Returns:IOSession.Status

session status.

Annotations

@Override

getTlsDetails	back to summary
public TlsDetails getTlsDetails()

hasCommands

back to summary

public boolean hasCommands()

Implements org.apache.hc.core5.reactor.IOSession.hasCommands.

Doc from org.apache.hc.core5.reactor.IOSession.hasCommands.

Tests if there enqueued commands pending execution.

Annotations

@Override

initialize	back to summary
private void initialize(final IOSession protocolSession) throws IOException

isOpen back to summary

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

poll back to summary

public Command poll()

Implements org.apache.hc.core5.reactor.IOSession.poll.

Doc from org.apache.hc.core5.reactor.IOSession.poll.

Removes first Command from the command queue if available.

Annotations

@Override

read back to summary

public int read(final ByteBuffer dst)

Implements java.nio.channels.ReadableByteChannel.read.

Doc from java.nio.channels.ReadableByteChannel.read.

Reads a sequence of bytes from this channel into the given buffer.

An attempt is made to read up to r bytes from the channel, where r is the number of bytes remaining in the buffer, that is, dst.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p + n - 1, where p is the buffer's position at the moment this method is invoked. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

A read operation might not fill the buffer, and in fact it might not read any bytes at all. Whether or not it does so depends upon the nature and state of the channel. A socket channel in non-blocking mode, for example, cannot read any more bytes than are immediately available from the socket's input buffer; similarly, a file channel cannot read any more bytes than remain in the file. It is guaranteed, however, that if a channel is in blocking mode and there is at least one byte remaining in the buffer then this method will block until at least one byte is read.

This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

dst:ByteBuffer: The buffer into which bytes are to be transferred

Returns:int

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

receiveEncryptedData	back to summary
private int receiveEncryptedData() throws IOException

sendEncryptedData	back to summary
private int sendEncryptedData() throws IOException

setEvent

back to summary

public void setEvent(final int op)

Implements org.apache.hc.core5.reactor.IOSession.setEvent.

Doc from org.apache.hc.core5.reactor.IOSession.setEvent.

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

Parameters

op:int: I/O event type.

Annotations

@Override

setEventMask

back to summary

public void setEventMask(final int ops)

Implements org.apache.hc.core5.reactor.IOSession.setEventMask.

Doc from org.apache.hc.core5.reactor.IOSession.setEventMask.

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

Parameters

ops:int: new I/O event mask.

Annotations

@Override

setSocketTimeout back to summary

public void setSocketTimeout(final Timeout timeout)

Implements org.apache.hc.core5.reactor.IOSession.setSocketTimeout.

Doc from org.apache.hc.core5.reactor.IOSession.setSocketTimeout.

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

Please note this operation may affect the last event time.

Parameters

timeout:Timeout: socket timeout.

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

updateEventMask	back to summary
private void updateEventMask()

updateReadTime

back to summary

public void updateReadTime()

Implements org.apache.hc.core5.reactor.IOSession.updateReadTime.

Doc from org.apache.hc.core5.reactor.IOSession.updateReadTime.

Updates the timestamp of the last read event

Annotations

@Override

updateWriteTime

back to summary

public void updateWriteTime()

Implements org.apache.hc.core5.reactor.IOSession.updateWriteTime.

Doc from org.apache.hc.core5.reactor.IOSession.updateWriteTime.

Updates the timestamp of the last write event

Annotations

@Override

upgrade

back to summary

public void upgrade(final IOEventHandler handler)

Implements org.apache.hc.core5.reactor.IOSession.upgrade.

Doc from org.apache.hc.core5.reactor.IOSession.upgrade.

Upgrades event handler associated with the session.

Annotations

@Override

write back to summary

public int write(final ByteBuffer src) throws IOException

Implements java.nio.channels.WritableByteChannel.write.

Doc from java.nio.channels.WritableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, src.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

src:ByteBuffer: The buffer from which bytes are to be retrieved

Returns:int

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

Modifier and Type	Field and Description
public static final SSLIOSession.TLSHandShakeState	COMPLETE
public static final SSLIOSession.TLSHandShakeState	HANDSHAKING
public static final SSLIOSession.TLSHandShakeState	INITIALIZED
public static final SSLIOSession.TLSHandShakeState	READY

Modifier and Type	Method and Description
public static SSLIOSession.TLSHandShakeState	valueOf(String name)
public static SSLIOSession.TLSHandShakeState[]	values()

public Class SSLIOSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum SSLIOSession.TLSHandShakeState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail