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

Class AbstractHttp1StreamDuplexer<IncomingMessage extends HttpMessage,OutgoingMessage extends HttpMessage>

java.lang.Object

org.apache.hc.core5.http.impl.nio.AbstractHttp1StreamDuplexer<IncomingMessage,OutgoingMessage>

All Implemented Interfaces:

Closeable, AutoCloseable, HttpConnection, SocketModalCloseable, ModalCloseable, Identifiable

Direct Known Subclasses:

ClientHttp1StreamDuplexer, ServerHttp1StreamDuplexer

abstract class AbstractHttp1StreamDuplexer<IncomingMessage extends HttpMessage,OutgoingMessage extends HttpMessage>
extends Object
implements Identifiable, HttpConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AbstractHttp1StreamDuplexer.CapacityWindow
private static enum	AbstractHttp1StreamDuplexer.ConnectionState
(package private) static enum	AbstractHttp1StreamDuplexer.MessageDelineation

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractHttp1StreamDuplexer.CapacityWindow	capacityWindow
private final BasicHttpConnectionMetrics	connMetrics
private AbstractHttp1StreamDuplexer.ConnectionState	connState
private final ByteBuffer	contentBuffer
private EndpointDetails	endpointDetails
private final Http1Config	http1Config
private final SessionInputBufferImpl	inbuf
private final ContentLengthStrategy	incomingContentStrategy
private Message<IncomingMessage,ContentDecoder>	incomingMessage
private final NHttpMessageParser<IncomingMessage>	incomingMessageParser
private final BasicHttpTransportMetrics	inTransportMetrics
private final ProtocolIOSession	ioSession
private final SessionOutputBufferImpl	outbuf
private final ContentLengthStrategy	outgoingContentStrategy
private Message<OutgoingMessage,ContentEncoder>	outgoingMessage
private final NHttpMessageWriter<OutgoingMessage>	outgoingMessageWriter
private final AtomicInteger	outputRequests
private final BasicHttpTransportMetrics	outTransportMetrics
private ProtocolVersion	version

Constructor Summary

Constructors

Constructor	Description
AbstractHttp1StreamDuplexer(ProtocolIOSession ioSession, Http1Config http1Config, CharCodingConfig charCodingConfig, NHttpMessageParser<IncomingMessage> incomingMessageParser, NHttpMessageWriter<OutgoingMessage> outgoingMessageWriter, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy)

Method Summary

Modifier and Type	Method	Description
(package private) void	appendState(StringBuilder buf)
void	close()	Closes this connection gracefully.
void	close(CloseMode closeMode)	Closes this process or endpoint and releases any system resources associated with it.
(package private) void	commitMessageHead(OutgoingMessage messageHead, boolean endStream, FlushMode flushMode)
(package private) abstract void	consumeData(ByteBuffer src)
(package private) abstract void	consumeHeader(IncomingMessage messageHead, EntityDetails entityDetails)
(package private) abstract ContentDecoder	createContentDecoder(long contentLength, ReadableByteChannel channel, SessionInputBuffer buffer, BasicHttpTransportMetrics metrics)
(package private) abstract ContentEncoder	createContentEncoder(long contentLength, WritableByteChannel channel, SessionOutputBuffer buffer, BasicHttpTransportMetrics metrics)
(package private) abstract void	dataEnd(List<? extends Header> trailers)
(package private) abstract void	disconnected()
(package private) AbstractHttp1StreamDuplexer.MessageDelineation	endOutputStream(List<? extends Header> trailers)
(package private) abstract void	execute(RequestExecutionCommand executionCommand)
EndpointDetails	getEndpointDetails()	Returns this connection's endpoint details.
String	getId()
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.
SocketAddress	getRemoteAddress()	Returns this connection's remote address or null if it is not connected yet or unconnected.
(package private) Timeout	getSessionTimeout()
Timeout	getSocketTimeout()	Returns the socket timeout value.
SSLSession	getSSLSession()	Returns this connection's SSL session or null if TLS has not been activated.
(package private) abstract boolean	handleIncomingMessage(IncomingMessage incomingMessage)
(package private) abstract boolean	handleOutgoingMessage(OutgoingMessage outgoingMessage)
(package private) abstract boolean	handleTimeout()
(package private) abstract void	inputEnd()
(package private) abstract boolean	inputIdle()
(package private) boolean	isActive()
boolean	isOpen()	Checks if this connection is open.
(package private) boolean	isOutputCompleted()
(package private) abstract boolean	isOutputReady()
(package private) boolean	isShuttingDown()
final void	onConnect()
final void	onDisconnect()
final void	onException(Exception ex)
final void	onInput(ByteBuffer src)
final void	onOutput()
final void	onTimeout(Timeout timeout)
(package private) abstract void	outputEnd()
(package private) abstract boolean	outputIdle()
(package private) IncomingMessage	parseMessageHead(boolean endOfStream)
private void	processCommands()
(package private) abstract void	produceOutput()
(package private) void	requestSessionInput()
(package private) void	requestSessionOutput()
(package private) void	requestShutdown(CloseMode closeMode)
(package private) void	setSessionTimeout(Timeout timeout)
void	setSocketTimeout(Timeout timeout)	Sets the socket timeout value.
(package private) void	shutdownSession(Exception cause)
(package private) void	shutdownSession(CloseMode closeMode)
(package private) int	streamOutput(ByteBuffer src)
(package private) void	suspendSessionInput()
(package private) void	suspendSessionOutput()
(package private) abstract void	terminate(Exception exception)
(package private) abstract void	updateCapacity(CapacityChannel capacityChannel)
(package private) abstract void	updateInputMetrics(IncomingMessage incomingMessage, BasicHttpConnectionMetrics connMetrics)
(package private) abstract void	updateOutputMetrics(OutgoingMessage outgoingMessage, BasicHttpConnectionMetrics connMetrics)

Methods inherited from class java.lang.Object

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

Field Details

ioSession

private final ProtocolIOSession ioSession

http1Config

private final Http1Config http1Config

inbuf

private final SessionInputBufferImpl inbuf

outbuf

private final SessionOutputBufferImpl outbuf

inTransportMetrics

private final BasicHttpTransportMetrics inTransportMetrics

outTransportMetrics

private final BasicHttpTransportMetrics outTransportMetrics

connMetrics

private final BasicHttpConnectionMetrics connMetrics

incomingMessageParser

private final NHttpMessageParser<IncomingMessage extends HttpMessage> incomingMessageParser

outgoingMessageWriter

private final NHttpMessageWriter<OutgoingMessage extends HttpMessage> outgoingMessageWriter

incomingContentStrategy

private final ContentLengthStrategy incomingContentStrategy

outgoingContentStrategy

private final ContentLengthStrategy outgoingContentStrategy

contentBuffer

private final ByteBuffer contentBuffer

outputRequests

private final AtomicInteger outputRequests

incomingMessage

private volatile Message<IncomingMessage extends HttpMessage,ContentDecoder> incomingMessage

outgoingMessage

private volatile Message<OutgoingMessage extends HttpMessage,ContentEncoder> outgoingMessage

connState

private volatile AbstractHttp1StreamDuplexer.ConnectionState connState

capacityWindow

private volatile AbstractHttp1StreamDuplexer.CapacityWindow capacityWindow

version

private volatile ProtocolVersion version

endpointDetails

private volatile EndpointDetails endpointDetails

Constructor Details

AbstractHttp1StreamDuplexer

AbstractHttp1StreamDuplexer(ProtocolIOSession ioSession,
 Http1Config http1Config,
 CharCodingConfig charCodingConfig,
 NHttpMessageParser<IncomingMessage> incomingMessageParser,
 NHttpMessageWriter<OutgoingMessage> outgoingMessageWriter,
 ContentLengthStrategy incomingContentStrategy,
 ContentLengthStrategy outgoingContentStrategy)

Method Details

getId

public String getId()

Specified by:

getId in interface Identifiable

isActive

boolean isActive()

isShuttingDown

boolean isShuttingDown()

shutdownSession

void shutdownSession(CloseMode closeMode)

shutdownSession

void shutdownSession(Exception cause)

disconnected

abstract void disconnected()

terminate

abstract void terminate(Exception exception)

updateInputMetrics

abstract void updateInputMetrics(IncomingMessage incomingMessage,
 BasicHttpConnectionMetrics connMetrics)

updateOutputMetrics

abstract void updateOutputMetrics(OutgoingMessage outgoingMessage,
 BasicHttpConnectionMetrics connMetrics)

consumeHeader

abstract void consumeHeader(IncomingMessage messageHead,
 EntityDetails entityDetails)
                     throws HttpException,
IOException

Throws:

HttpException

IOException

handleIncomingMessage

abstract boolean handleIncomingMessage(IncomingMessage incomingMessage)
                                throws HttpException

Throws:

HttpException

handleOutgoingMessage

abstract boolean handleOutgoingMessage(OutgoingMessage outgoingMessage)
                                throws HttpException

Throws:

HttpException

createContentDecoder

abstract ContentDecoder createContentDecoder(long contentLength,
 ReadableByteChannel channel,
 SessionInputBuffer buffer,
 BasicHttpTransportMetrics metrics)
                                      throws HttpException

Throws:

HttpException

createContentEncoder

abstract ContentEncoder createContentEncoder(long contentLength,
 WritableByteChannel channel,
 SessionOutputBuffer buffer,
 BasicHttpTransportMetrics metrics)
                                      throws HttpException

Throws:

HttpException

consumeData

abstract void consumeData(ByteBuffer src)
                   throws HttpException,
IOException

Throws:

HttpException

IOException

updateCapacity

abstract void updateCapacity(CapacityChannel capacityChannel)
                      throws HttpException,
IOException

Throws:

HttpException

IOException

dataEnd

abstract void dataEnd(List<? extends Header> trailers)
               throws HttpException,
IOException

Throws:

HttpException

IOException

isOutputReady

abstract boolean isOutputReady()

produceOutput

abstract void produceOutput()
                     throws HttpException,
IOException

Throws:

HttpException

IOException

execute

abstract void execute(RequestExecutionCommand executionCommand)
               throws HttpException,
IOException

Throws:

HttpException

IOException

inputEnd

abstract void inputEnd()
                throws HttpException,
IOException

Throws:

HttpException

IOException

outputEnd

abstract void outputEnd()
                 throws HttpException,
IOException

Throws:

HttpException

IOException

inputIdle

abstract boolean inputIdle()

outputIdle

abstract boolean outputIdle()

handleTimeout

abstract boolean handleTimeout()

processCommands

private void processCommands()
                      throws HttpException,
IOException

Throws:

HttpException

IOException

onConnect

public final void onConnect()
                     throws HttpException,
IOException

Throws:

HttpException

IOException

parseMessageHead

IncomingMessage parseMessageHead(boolean endOfStream)
                          throws IOException,
HttpException

Throws:

IOException

HttpException

onInput

public final void onInput(ByteBuffer src)
                   throws HttpException,
IOException

Throws:

HttpException

IOException

onOutput

public final void onOutput()
                    throws IOException,
HttpException

Throws:

IOException

HttpException

onTimeout

public final void onTimeout(Timeout timeout)
                     throws IOException,
HttpException

Throws:

IOException

HttpException

onException

public final void onException(Exception ex)

onDisconnect

public final void onDisconnect()

requestShutdown

void requestShutdown(CloseMode closeMode)

commitMessageHead

void commitMessageHead(OutgoingMessage messageHead,
 boolean endStream,
 FlushMode flushMode)
                throws HttpException,
IOException

Throws:

HttpException

IOException

requestSessionInput

void requestSessionInput()

requestSessionOutput

void requestSessionOutput()

getSessionTimeout

Timeout getSessionTimeout()

setSessionTimeout

void setSessionTimeout(Timeout timeout)

suspendSessionInput

void suspendSessionInput()

suspendSessionOutput

void suspendSessionOutput()
                   throws IOException

Throws:

IOException

streamOutput

int streamOutput(ByteBuffer src)
          throws IOException

Throws:

IOException

endOutputStream

AbstractHttp1StreamDuplexer.MessageDelineation endOutputStream(List<? extends Header> trailers)
                                                        throws IOException

Throws:

IOException

isOutputCompleted

boolean isOutputCompleted()

close

public void close()
           throws 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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface HttpConnection

Throws:

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.

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.

getSocketTimeout

public Timeout getSocketTimeout()

Description copied from interface: SocketModalCloseable

Returns the socket timeout value.

Specified by:

getSocketTimeout in interface SocketModalCloseable

Returns:

timeout value.

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

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.

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

getSSLSession

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

appendState

void appendState(StringBuilder buf)