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

类 AbstractContentEncoder

java.lang.Object

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

所有已实现的接口:

ContentEncoder

直接已知子类:

ChunkEncoder, IdentityEncoder, LengthDelimitedEncoder

public abstract class AbstractContentEncoder
extends Object
implements ContentEncoder

Abstract ContentEncoder that serves as a base for all content encoder implementations.

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
AbstractContentEncoder(WritableByteChannel channel, SessionOutputBuffer buffer, BasicHttpTransportMetrics metrics) Creates an instance of this class.

方法概要

限定符和类型	方法和说明
protected void	assertNotCompleted()
protected SessionOutputBuffer	buffer()
protected WritableByteChannel	channel()
void	complete()
void	complete(List<? extends Header> trailers) Terminates the content stream.
protected int	flushToChannel() Flushes content of the session buffer to the channel and updates transport metrics.
boolean	isCompleted() Returns true if the entity has been transferred in its entirety.
protected BasicHttpTransportMetrics	metrics()
protected int	writeToBuffer(ByteBuffer src, int limit) Transfers content of the source to the buffer and updates transport metrics.
protected int	writeToChannel(ByteBuffer src) Flushes content of the given buffer to the channel and updates transport metrics.
protected int	writeToChannel(ByteBuffer src, int limit) Transfers content of the source to the channel and updates transport metrics.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.hc.core5.http.nio.ContentEncoder

write

构造器详细资料

AbstractContentEncoder

public AbstractContentEncoder(WritableByteChannel channel,
                              SessionOutputBuffer buffer,
                              BasicHttpTransportMetrics metrics)

Creates an instance of this class.

参数:

channel - the destination channel.

buffer - the session output buffer that can be used to store session data for intermediate processing.

metrics - Transport metrics of the underlying HTTP transport.

方法详细资料

channel

protected WritableByteChannel channel()

buffer

protected SessionOutputBuffer buffer()

metrics

protected BasicHttpTransportMetrics metrics()

isCompleted

public boolean isCompleted()

从接口复制的说明: ContentEncoder

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

指定者:

isCompleted 在接口中 ContentEncoder

返回:

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

complete

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

从接口复制的说明: ContentEncoder

Terminates the content stream.

指定者:

complete 在接口中 ContentEncoder

抛出:

IOException - if I/O error occurs while writing content

complete

public final void complete()
                    throws IOException

抛出:

IOException

assertNotCompleted

protected void assertNotCompleted()

flushToChannel

protected int flushToChannel()
                      throws IOException

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

返回:

number of bytes written to the channel.

抛出:

IOException

从以下版本开始:

4.3

writeToChannel

protected int writeToChannel(ByteBuffer src)
                      throws IOException

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

返回:

number of bytes written to the channel.

抛出:

IOException

从以下版本开始:

4.3

writeToChannel

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

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

参数:

src - source.

limit - max number of bytes to transfer.

返回:

number of bytes transferred.

抛出:

IOException

从以下版本开始:

4.3

writeToBuffer

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

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

参数:

src - source.

limit - max number of bytes to transfer.

返回:

number of bytes transferred.

抛出:

IOException

从以下版本开始:

4.3