Module org.eclipse.jetty.io

Package org.eclipse.jetty.io.ssl

Class SslConnection.SslEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.ssl.SslConnection.SslEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, Content.Sink, EndPoint, EndPoint.Wrapper

Enclosing class:

SslConnection

public class SslConnection.SslEndPoint
extends AbstractEndPoint
implements EndPoint.Wrapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.EndPoint

EndPoint.Pipe, EndPoint.SslSessionData, EndPoint.Wrapper

Field Summary

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

EOF

Constructor Summary

Constructors

Constructor	Description
SslEndPoint()

Method Summary

Modifier and Type	Method	Description
void	doClose()
void	doShutdownOutput()
int	fill(ByteBuffer buffer)	Fills the passed buffer with data from this endpoint.
boolean	flush(ByteBuffer... appOuts)	Flushes data from the passed header/buffer to this endpoint.
long	getIdleTimeout()	Returns the idle timeout in ms.
SocketAddress	getLocalSocketAddress()
SocketAddress	getRemoteSocketAddress()
SslConnection	getSslConnection()
EndPoint.SslSessionData	getSslSessionData()	Returns the SslSessionData of a secure end point.
Object	getTransport()
WriteFlusher	getWriteFlusher()
boolean	isInputShutdown()	Tests if the input is shutdown.
boolean	isOpen()	This abstract method should be called to check if idle timeouts should still be checked.
boolean	isOutputShutdown()	Tests if output is shutdown.
protected void	needsFillInterest()
protected void	onFillable()
protected void	onFillableFail(Throwable failure)
protected void	onIncompleteFlush()
void	setConnection(Connection connection)
void	setIdleTimeout(long idleTimeout)	Sets the idle timeout in milliseconds.
String	toString()
EndPoint	unwrap()

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

cancelWrite, close, close, doShutdownInput, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, isFillInterested, onClose, onClose, onIdleExpired, onOpen, reset, shutdownInput, shutdownOutput, toConnectionString, toEndPointString, tryFillInterested, upgrade, write

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

checkIdleTimeout, getIdleFor, getScheduler, notIdle

Methods inherited from class java.lang.Object

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

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

isSecure, receive, send, write, write

Constructor Details

SslEndPoint

public SslEndPoint()

Method Details

unwrap

public EndPoint unwrap()

Specified by:

unwrap in interface EndPoint.Wrapper

Returns:

The wrapped EndPoint

getIdleTimeout

public long getIdleTimeout()

Description copied from interface: EndPoint

Returns the idle timeout in ms.

The idle timeout is the time the endpoint can be idle before its close is initiated.

A timeout less than or equal to 0 implies an infinite timeout.

Specified by:

getIdleTimeout in interface EndPoint

Overrides:

getIdleTimeout in class IdleTimeout

Returns:

the idle timeout in milliseconds

See Also:

• IdleTimeout.setIdleTimeout(long)

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Description copied from class: IdleTimeout

Sets the idle timeout in milliseconds.

A value that is less than or zero disables the idle timeout checks.

Specified by:

setIdleTimeout in interface EndPoint

Overrides:

setIdleTimeout in class IdleTimeout

Parameters:

idleTimeout - the idle timeout in milliseconds

See Also:

• IdleTimeout.getIdleTimeout()

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

Overrides:

isOpen in class AbstractEndPoint

Returns:

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

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface EndPoint

Specified by:

getLocalSocketAddress in class AbstractEndPoint

Returns:

the local SocketAddress to which this EndPoint is bound or null if this EndPoint is not bound to a Socket address.

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface EndPoint

Specified by:

getRemoteSocketAddress in class AbstractEndPoint

Returns:

The remote SocketAddress to which this EndPoint is connected, or null if this EndPoint is not connected to a Socket address.

getWriteFlusher

public WriteFlusher getWriteFlusher()

Overrides:

getWriteFlusher in class AbstractEndPoint

onFillable

protected void onFillable()

onFillableFail

protected void onFillableFail(Throwable failure)

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(ByteBuffer buffer)
         throws IOException

Description copied from interface: EndPoint

Fills 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 its capacity. The limit is updated to include the filled bytes.

Specified by:

fill in interface EndPoint

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:

IOException - if the endpoint is closed.

needsFillInterest

protected void needsFillInterest()

Specified by:

needsFillInterest in class AbstractEndPoint

flush

public boolean flush(ByteBuffer... appOuts)
              throws IOException

Description copied from interface: EndPoint

Flushes 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.

Specified by:

flush in interface EndPoint

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:

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

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

doShutdownOutput

public void doShutdownOutput()

Overrides:

doShutdownOutput in class AbstractEndPoint

isOutputShutdown

public boolean isOutputShutdown()

Description copied from interface: EndPoint

Tests if output is shutdown.

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

Specified by:

isOutputShutdown in interface EndPoint

Overrides:

isOutputShutdown in class AbstractEndPoint

Returns:

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

doClose

public void doClose()

Overrides:

doClose in class AbstractEndPoint

getTransport

public Object getTransport()

Specified by:

getTransport in interface EndPoint

Returns:

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

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: EndPoint

Tests 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.

Specified by:

isInputShutdown in interface EndPoint

Overrides:

isInputShutdown in class AbstractEndPoint

Returns:

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

getSslSessionData

public EndPoint.SslSessionData getSslSessionData()

Description copied from interface: EndPoint

Returns the SslSessionData of a secure end point.

Specified by:

getSslSessionData in interface EndPoint

Returns:

A EndPoint.SslSessionData instance (with possibly null field values) if secure, else null.

toString

public String toString()

Overrides:

toString in class AbstractEndPoint