Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.impl.nio.AbstractContentEncoder

Modifier and Type	Field and Description
pack-priv final SessionOutputBuffer	buffer
pack-priv final WritableByteChannel	channel
pack-priv boolean	completed
pack-priv final BasicHttpTransportMetrics	metrics

Access	Constructor and Description
public	AbstractContentEncoder(final WritableByteChannel the destination channel. channel, final SessionOutputBuffer the session output buffer that can be used to store session data for intermediate processing. buffer, final BasicHttpTransportMetrics Transport metrics of the underlying HTTP transport. metrics) Creates an instance of this class.

Method Summary

Modifier and Type	Method and Description
protected void	assertNotCompleted()
protected SessionOutputBuffer	buffer()
protected WritableByteChannel	channel()
public void	complete(final List<? extends Header> trailers) Implements org.apache.hc.core5.http.nio.ContentEncoder.complete. Terminates the content stream.
public final void	complete()
private int	doWriteChunk(final ByteBuffer src, final int chunk, final boolean direct)
private int	doWriteChunk(final ByteBuffer src, final boolean direct)
protected int	Returns: number of bytes written to the channel. flushToChannel() Flushes content of the session buffer to the channel and updates transport metrics.
public boolean	isCompleted() Implements org.apache.hc.core5.http.nio.ContentEncoder.isCompleted. Returns `true` if the entity has been transferred in its entirety.
protected BasicHttpTransportMetrics	metrics()
protected int	Returns: number of bytes transferred. writeToBuffer(final ByteBuffer source. src, final int max number of bytes to transfer. limit) Transfers content of the source to the buffer and updates transport metrics.
protected int	Returns: number of bytes written to the channel. writeToChannel(final ByteBuffer src) Flushes content of the given buffer to the channel and updates transport metrics.
protected int	Returns: number of bytes transferred. writeToChannel(final ByteBuffer source. src, final int max number of bytes to transfer. limit) Transfers content of the source to the channel and updates transport metrics.

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

buffer	back to summary
pack-priv final SessionOutputBuffer buffer

channel	back to summary
pack-priv final WritableByteChannel channel

completed	back to summary
pack-priv boolean completed

metrics	back to summary
pack-priv final BasicHttpTransportMetrics metrics

AbstractContentEncoder	back to summary
public AbstractContentEncoder(final WritableByteChannel channel, final SessionOutputBuffer buffer, final BasicHttpTransportMetrics metrics) Creates an instance of this class. Parameters channel:WritableByteChannel the destination channel. buffer:SessionOutputBuffer the session output buffer that can be used to store session data for intermediate processing. metrics:BasicHttpTransportMetrics Transport metrics of the underlying HTTP transport.

Method Detail

assertNotCompleted	back to summary
protected void assertNotCompleted()

buffer	back to summary
protected SessionOutputBuffer buffer()

channel	back to summary
protected WritableByteChannel channel()

complete	back to summary
public void complete(final List<? extends Header> trailers) throws IOException Implements org.apache.hc.core5.http.nio.ContentEncoder.complete. Doc from org.apache.hc.core5.http.nio.ContentEncoder.complete. Terminates the content stream. Annotations @Override Exceptions IOException: if I/O error occurs while writing content

complete

back to summary

public void complete(final List<? extends Header> trailers) throws IOException

Implements org.apache.hc.core5.http.nio.ContentEncoder.complete.

Doc from org.apache.hc.core5.http.nio.ContentEncoder.complete.

Terminates the content stream.

Annotations

@Override

Exceptions

IOException:: if I/O error occurs while writing content

complete	back to summary
public final void complete() throws IOException

doWriteChunk	back to summary
private int doWriteChunk(final ByteBuffer src, final int chunk, final boolean direct) throws IOException

doWriteChunk	back to summary
private int doWriteChunk(final ByteBuffer src, final boolean direct) throws IOException

flushToChannel	back to summary
protected int flushToChannel() throws IOException Flushes content of the session buffer to the channel and updates transport metrics. Returns:int number of bytes written to the channel. Since 4.3

flushToChannel

back to summary

protected int flushToChannel() throws IOException

Flushes content of the session buffer to the channel and updates transport metrics.

Returns:int: number of bytes written to the channel.
Since: 4.3

isCompleted back to summary

isCompleted	back to summary
public boolean isCompleted() Implements org.apache.hc.core5.http.nio.ContentEncoder.isCompleted. Doc from org.apache.hc.core5.http.nio.ContentEncoder.isCompleted. Returns `true` if the entity has been transferred in its entirety. Returns:boolean `true` if all the content has been produced, `false` otherwise. Annotations @Override

public boolean isCompleted()

Implements org.apache.hc.core5.http.nio.ContentEncoder.isCompleted.

Doc from org.apache.hc.core5.http.nio.ContentEncoder.isCompleted.

Returns true if the entity has been transferred in its entirety.

Returns:boolean

true if all the content has been produced, false otherwise.

Annotations

@Override

metrics	back to summary
protected BasicHttpTransportMetrics metrics()

writeToBuffer	back to summary
protected int writeToBuffer(final ByteBuffer src, final int limit) throws IOException Transfers content of the source to the buffer and updates transport metrics. Parameters src:ByteBuffer source. limit:int max number of bytes to transfer. Returns:int number of bytes transferred. Since 4.3

writeToBuffer

back to summary

protected int writeToBuffer(final ByteBuffer src, final int limit) throws IOException

Transfers content of the source to the buffer and updates transport metrics.

Parameters

src:ByteBuffer: source.
limit:int: max number of bytes to transfer.

Returns:int

number of bytes transferred.

Since

4.3

writeToChannel	back to summary
protected int writeToChannel(final ByteBuffer src) throws IOException Flushes content of the given buffer to the channel and updates transport metrics. Returns:int number of bytes written to the channel. Since 4.3

writeToChannel

back to summary

protected int writeToChannel(final ByteBuffer src) throws IOException

Flushes content of the given buffer to the channel and updates transport metrics.

Returns:int: number of bytes written to the channel.
Since: 4.3

writeToChannel	back to summary
protected int writeToChannel(final ByteBuffer src, final int limit) throws IOException Transfers content of the source to the channel and updates transport metrics. Parameters src:ByteBuffer source. limit:int max number of bytes to transfer. Returns:int number of bytes transferred. Since 4.3

writeToChannel

back to summary

protected int writeToChannel(final ByteBuffer src, final int limit) throws IOException

Transfers content of the source to the channel and updates transport metrics.

Parameters

src:ByteBuffer: source.
limit:int: max number of bytes to transfer.

Returns:int

number of bytes transferred.

Since

4.3

public abstract Class AbstractContentEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail