Package org.eclipse.jetty.io.ssl

Class SslConnection.DecryptedEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.ssl.SslConnection.DecryptedEndPoint

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, EndPoint

Enclosing class:

SslConnection

public class SslConnection.DecryptedEndPoint
extends AbstractEndPoint

Constructor Summary

Constructors

Constructor	Description
DecryptedEndPoint()

Method Summary

Modifier and Type	Method	Description
void	close()	Close any backing stream associated with the endpoint
protected void	close(java.lang.Throwable failure)
int	fill(java.nio.ByteBuffer buffer)	Fill the passed buffer with data from this endpoint.
boolean	flush(java.nio.ByteBuffer... appOuts)	Flush data from the passed header/buffer to this endpoint.
long	getIdleTimeout()	Get the max idle time in ms.
SslConnection	getSslConnection()
java.lang.Object	getTransport()
protected WriteFlusher	getWriteFlusher()
boolean	isInputShutdown()	Test if the input is shutdown.
boolean	isOpen()	This abstract method should be called to check if idle timeouts should still be checked.
boolean	isOutputShutdown()	Test if output is shutdown.
protected void	needsFillInterest()
protected void	onIncompleteFlush()
void	setConnection(Connection connection)
void	setIdleTimeout(long idleTimeout)	Set the idle timeout.
void	shutdownOutput()	Shutdown the output.
java.lang.String	toString()

Methods inherited from class org.eclipse.jetty.io.AbstractEndPoint

fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getLocalAddress, getRemoteAddress, isFillInterested, isOptimizedForDirectBuffers, onIdleExpired, onOpen, tryFillInterested, upgrade, write

Methods inherited from interface org.eclipse.jetty.io.EndPoint

onClose

Methods inherited from class org.eclipse.jetty.io.IdleTimeout

checkIdleTimeout, getIdleFor, getIdleTimestamp, getScheduler, notIdle, onClose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DecryptedEndPoint

public DecryptedEndPoint()

Method Detail

getIdleTimeout

public long getIdleTimeout()

Description copied from interface: EndPoint

Get the max idle time in ms.

The max idle time is the time the endpoint can be idle before extraordinary handling takes place.

Specified by:

getIdleTimeout in interface EndPoint

Overrides:

getIdleTimeout in class IdleTimeout

Returns:

the max idle time in ms or if ms <= 0 implies an infinite timeout

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Description copied from interface: EndPoint

Set the idle timeout.

Specified by:

setIdleTimeout in interface EndPoint

Overrides:

setIdleTimeout in class IdleTimeout

Parameters:

idleTimeout - the idle timeout in MS. Timeout <= 0 implies an infinite timeout

isOpen

public boolean isOpen()

Description copied from class: IdleTimeout

This abstract method should be called to check if idle timeouts should still be checked.

Specified by:

isOpen in interface EndPoint

Specified by:

isOpen in class IdleTimeout

Returns:

True if the entity monitored should still be checked for idle timeouts

getWriteFlusher

protected WriteFlusher getWriteFlusher()

Overrides:

getWriteFlusher in class AbstractEndPoint

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

needsFillInterest

protected void needsFillInterest()
                          throws java.io.IOException

Specified by:

needsFillInterest in class AbstractEndPoint

Throws:

java.io.IOException

setConnection

public void setConnection(Connection connection)

Specified by:

setConnection in interface EndPoint

Overrides:

setConnection in class AbstractEndPoint

Parameters:

connection - the Connection associated with this EndPoint

See Also:

EndPoint.getConnection(), EndPoint.upgrade(Connection)

getSslConnection

public SslConnection getSslConnection()

fill

public int fill(java.nio.ByteBuffer buffer)
         throws java.io.IOException

Description copied from interface: EndPoint

Fill the passed buffer with data from this endpoint. The bytes are appended to any data already in the buffer by writing from the buffers limit up to it's capacity. The limit is updated to include the filled bytes.

Parameters:

buffer - The buffer to fill. The position and limit are modified during the fill. After the operation, the position is unchanged and the limit is increased to reflect the new data filled.

Returns:

an int value indicating the number of bytes filled or -1 if EOF is read or the input is shutdown.

Throws:

java.io.IOException - if the endpoint is closed.

flush

public boolean flush(java.nio.ByteBuffer... appOuts)
              throws java.io.IOException

Description copied from interface: EndPoint

Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed are taken from the header/buffer position up until the buffer limit. The header/buffers position is updated to indicate how many bytes have been consumed.

Parameters:

appOuts - the buffers to flush

Returns:

True IFF all the buffers have been consumed and the endpoint has flushed the data to its destination (ie is not buffering any data).

Throws:

java.io.IOException - If the endpoint is closed or output is shutdown.

shutdownOutput

public void shutdownOutput()

Description copied from interface: EndPoint

Shutdown the output.

This call indicates that no more data will be sent on this endpoint that that the remote end should read an EOF once all previously sent data has been consumed. Shutdown may be done either at the TCP/IP level, as a protocol exchange (Eg TLS close handshake) or both.

If the endpoint has EndPoint.isInputShutdown() true, then this call has the same effect as EndPoint.close().

isOutputShutdown

public boolean isOutputShutdown()

Description copied from interface: EndPoint

Test if output is shutdown. The output is shutdown by a call to EndPoint.shutdownOutput() or EndPoint.close().

Returns:

true if the output is shutdown or the endpoint is closed.

close

public void close()

Description copied from interface: EndPoint

Close any backing stream associated with the endpoint

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface EndPoint

Overrides:

close in class AbstractEndPoint

close

protected void close(java.lang.Throwable failure)

Overrides:

close in class AbstractEndPoint

getTransport

public java.lang.Object getTransport()

Returns:

The underlying transport object (socket, channel, etc.)

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: EndPoint

Test if the input is shutdown. The input is shutdown if an EOF has been read while doing a EndPoint.fill(ByteBuffer). Once the input is shutdown, all calls to EndPoint.fill(ByteBuffer) will return -1, until such time as the end point is close, when they will return EofException.

Returns:

True if the input is shutdown or the endpoint is closed.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractEndPoint