Package org.apache.hc.core5.http2.impl.nio

Class PrefaceHandlerBase

java.lang.Object

org.apache.hc.core5.http2.impl.nio.PrefaceHandlerBase

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HttpConnection, HttpConnectionEventHandler, SocketModalCloseable, ModalCloseable, IOEventHandler

Direct Known Subclasses:

ClientH2PrefaceHandler, ServerH2PrefaceHandler

abstract class PrefaceHandlerBase
extends java.lang.Object
implements HttpConnectionEventHandler

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.concurrent.atomic.AtomicBoolean	completed
(package private) ProtocolIOSession	ioSession
private java.util.concurrent.atomic.AtomicReference<HttpConnectionEventHandler>	protocolHandlerRef
private FutureCallback<ProtocolIOSession>	resultCallback

Constructor Summary

Constructors

Constructor	Description
PrefaceHandlerBase(ProtocolIOSession ioSession, FutureCallback<ProtocolIOSession> resultCallback)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this connection gracefully.
void	close(CloseMode closeMode)	Closes this process or endpoint and releases any system resources associated with it.
void	disconnected(IOSession session)	Triggered when the given session has been terminated.
void	exception(IOSession session, java.lang.Exception cause)	Triggered when the given session throws a exception.
EndpointDetails	getEndpointDetails()	Returns this connection's endpoint details.
java.net.SocketAddress	getLocalAddress()	Returns this connection's local address or null if it is not bound yet.
ProtocolVersion	getProtocolVersion()	Returns this connection's protocol version or null if unknown.
java.net.SocketAddress	getRemoteAddress()	Returns this connection's remote address or null if it is not connected yet or unconnected.
Timeout	getSocketTimeout()	Returns the socket timeout value.
javax.net.ssl.SSLSession	getSSLSession()	Returns this connection's SSL session or null if TLS has not been activated.
boolean	isOpen()	Checks if this connection is open.
void	setSocketTimeout(Timeout timeout)	Sets the socket timeout value.
(package private) void	startProtocol(HttpConnectionEventHandler protocolHandler, java.nio.ByteBuffer data)
void	timeout(IOSession session, Timeout timeout)	Triggered when the given session has timed out.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hc.core5.reactor.IOEventHandler

connected, inputReady, outputReady

Field Detail

ioSession

final ProtocolIOSession ioSession

protocolHandlerRef

private final java.util.concurrent.atomic.AtomicReference<HttpConnectionEventHandler> protocolHandlerRef

resultCallback

private final FutureCallback<ProtocolIOSession> resultCallback

completed

private final java.util.concurrent.atomic.AtomicBoolean completed

Constructor Detail

PrefaceHandlerBase

PrefaceHandlerBase(ProtocolIOSession ioSession,
                   FutureCallback<ProtocolIOSession> resultCallback)

Method Detail

startProtocol

void startProtocol(HttpConnectionEventHandler protocolHandler,
                   java.nio.ByteBuffer data)
            throws java.io.IOException

Throws:

java.io.IOException

timeout

public void timeout(IOSession session,
                    Timeout timeout)

Description copied from interface: IOEventHandler

Triggered when the given session has timed out.

Specified by:

timeout in interface IOEventHandler

Parameters:

session - the I/O session.

timeout - the timeout.

exception

public void exception(IOSession session,
                      java.lang.Exception cause)

Description copied from interface: IOEventHandler

Triggered when the given session throws a exception.

Specified by:

exception in interface IOEventHandler

Parameters:

session - the I/O session.

disconnected

public void disconnected(IOSession session)

Description copied from interface: IOEventHandler

Triggered when the given session has been terminated.

Specified by:

disconnected in interface IOEventHandler

Parameters:

session - the I/O session.

getSSLSession

public javax.net.ssl.SSLSession getSSLSession()

Description copied from interface: HttpConnection

Returns this connection's SSL session or null if TLS has not been activated.

Specified by:

getSSLSession in interface HttpConnection

Returns:

this connection's SSL session or null if TLS has not been activated.

getEndpointDetails

public EndpointDetails getEndpointDetails()

Description copied from interface: HttpConnection

Returns this connection's endpoint details.

Specified by:

getEndpointDetails in interface HttpConnection

Returns:

this connection's endpoint details.

setSocketTimeout

public void setSocketTimeout(Timeout timeout)

Description copied from interface: SocketModalCloseable

Sets the socket timeout value.

Specified by:

setSocketTimeout in interface SocketModalCloseable

Parameters:

timeout - timeout value

getSocketTimeout

public Timeout getSocketTimeout()

Description copied from interface: SocketModalCloseable

Returns the socket timeout value.

Specified by:

getSocketTimeout in interface SocketModalCloseable

Returns:

timeout value.

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Description copied from interface: HttpConnection

Returns this connection's protocol version or null if unknown.

Specified by:

getProtocolVersion in interface HttpConnection

Returns:

this connection's protocol version or null if unknown.

getRemoteAddress

public java.net.SocketAddress getRemoteAddress()

Description copied from interface: HttpConnection

Returns this connection's remote address or null if it is not connected yet or unconnected.

Specified by:

getRemoteAddress in interface HttpConnection

Returns:

this connection's remote address or null if it is not connected yet or unconnected.

getLocalAddress

public java.net.SocketAddress getLocalAddress()

Description copied from interface: HttpConnection

Returns this connection's local address or null if it is not bound yet.

Specified by:

getLocalAddress in interface HttpConnection

Returns:

this connection's local address or null if it is not bound yet.

isOpen

public boolean isOpen()

Description copied from interface: HttpConnection

Checks if this connection is open.

Specified by:

isOpen in interface HttpConnection

Returns:

true if it is open, false if it is closed.

close

public void close()
           throws java.io.IOException

Description copied from interface: HttpConnection

Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface HttpConnection

Throws:

java.io.IOException

close

public void close(CloseMode closeMode)

Description copied from interface: ModalCloseable

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.

Specified by:

close in interface ModalCloseable

Parameters:

closeMode - How to close the receiver.