org.apache.hc.core5.http.nio.entity

类 AbstractBinAsyncEntityProducer

java.lang.Object

org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityProducer

所有已实现的接口:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder

@Contract(threading=SAFE_CONDITIONAL)
public abstract class AbstractBinAsyncEntityProducer
extends Object
implements AsyncEntityProducer

Abstract binary entity content producer.

从以下版本开始:

5.0

构造器概要

构造器

构造器和说明
AbstractBinAsyncEntityProducer(int fragmentSizeHint, ContentType contentType)

方法概要

限定符和类型	方法和说明
int	available() Returns the number of bytes immediately available for output.
protected abstract int	availableData() Returns the number of bytes immediately available for output.
String	getContentEncoding() Returns content encoding of the entity, if known.
long	getContentLength() Returns length of the entity, if known.
String	getContentType() Returns content type of the entity, if known.
Set<String>	getTrailerNames() Preliminary declaration of trailing headers.
boolean	isChunked() Returns chunked transfer hint for this entity.
void	produce(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.
protected abstract void	produceData(StreamChannel<ByteBuffer> channel) Triggered to signal the ability of the underlying byte channel to accept more data.
void	releaseResources()

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

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

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

failed, isRepeatable

构造器详细资料

AbstractBinAsyncEntityProducer

public AbstractBinAsyncEntityProducer(int fragmentSizeHint,
                                      ContentType contentType)

方法详细资料

availableData

protected abstract int availableData()

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

返回:

the number of bytes immediately available for output

produceData

protected abstract void produceData(StreamChannel<ByteBuffer> channel)
                             throws IOException

Triggered to signal the ability of the underlying byte channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

StreamChannel passed to this method is threading-safe.

参数:

channel - the data channel capable to accepting more data.

抛出:

IOException

getContentType

public final String getContentType()

从接口复制的说明: EntityDetails

Returns content type of the entity, if known.

指定者:

getContentType 在接口中 EntityDetails

getContentEncoding

public String getContentEncoding()

从接口复制的说明: EntityDetails

Returns content encoding of the entity, if known.

指定者:

getContentEncoding 在接口中 EntityDetails

isChunked

public boolean isChunked()

从接口复制的说明: EntityDetails

Returns chunked transfer hint for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

指定者:

isChunked 在接口中 EntityDetails

getTrailerNames

public Set<String> getTrailerNames()

从接口复制的说明: EntityDetails

Preliminary declaration of trailing headers.

指定者:

getTrailerNames 在接口中 EntityDetails

getContentLength

public long getContentLength()

从接口复制的说明: EntityDetails

Returns length of the entity, if known.

指定者:

getContentLength 在接口中 EntityDetails

available

public final int available()

从接口复制的说明: AsyncDataProducer

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

指定者:

available 在接口中 AsyncDataProducer

返回:

the number of bytes immediately available for output

produce

public final void produce(DataStreamChannel channel)
                   throws IOException

从接口复制的说明: AsyncDataProducer

Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

指定者:

produce 在接口中 AsyncDataProducer

参数:

channel - the data channel capable to accepting more data.

抛出:

IOException

releaseResources

public void releaseResources()

指定者:

releaseResources 在接口中 ResourceHolder