Class AbstractCharAsyncEntityProducer
java.lang.Object
org.apache.hc.core5.http.nio.entity.AbstractCharAsyncEntityProducer
- All Implemented Interfaces:
EntityDetails
,AsyncDataProducer
,AsyncEntityProducer
,ResourceHolder
- Direct Known Subclasses:
StringAsyncEntityProducer
@Contract(threading=SAFE_CONDITIONAL)
public abstract class AbstractCharAsyncEntityProducer
extends Object
implements AsyncEntityProducer
Abstract text entity content producer.
- Since:
- 5.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static enum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ByteBuffer
private final CharsetEncoder
private final ContentType
private static final CharBuffer
private final int
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractCharAsyncEntityProducer
(int bufferSize, int fragmentSizeHint, ContentType contentType) -
Method Summary
Modifier and TypeMethodDescriptionfinal int
Returns the number of bytes immediately available for output.protected abstract int
Returns the number of bytes immediately available for output.private void
flush
(StreamChannel<ByteBuffer> channel) Returns content encoding of the entity, if known.long
Returns length of the entity, if known.final String
Returns content type of the entity, if known.Preliminary declaration of trailing headers.boolean
Returns chunked transfer hint for this entity.final void
produce
(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.protected abstract void
produceData
(StreamChannel<CharBuffer> channel) Triggered to signal the ability of the underlying char channel to accept more data.void
(package private) final void
streamEnd
(StreamChannel<ByteBuffer> channel) (package private) final int
writeData
(StreamChannel<ByteBuffer> channel, CharBuffer src) 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.http.nio.AsyncEntityProducer
failed, isRepeatable
-
Field Details
-
EMPTY
-
bytebuf
-
fragmentSizeHint
private final int fragmentSizeHint -
contentType
-
charsetEncoder
-
state
-
-
Constructor Details
-
AbstractCharAsyncEntityProducer
public AbstractCharAsyncEntityProducer(int bufferSize, int fragmentSizeHint, ContentType contentType)
-
-
Method Details
-
flush
- Throws:
IOException
-
writeData
- Throws:
IOException
-
streamEnd
- Throws:
IOException
-
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.- Returns:
- the number of bytes immediately available for output
-
produceData
Triggered to signal the ability of the underlying char 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.- Parameters:
channel
- the data channel capable to accepting more data.- Throws:
IOException
-
getContentType
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
getContentEncoding
Description copied from interface:EntityDetails
Returns content encoding of the entity, if known.- Specified by:
getContentEncoding
in interfaceEntityDetails
-
getContentLength
public long getContentLength()Description copied from interface:EntityDetails
Returns length of the entity, if known.- Specified by:
getContentLength
in interfaceEntityDetails
-
isChunked
public boolean isChunked()Description copied from interface:EntityDetails
Returns chunked transfer hint for this entity.The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
- Specified by:
isChunked
in interfaceEntityDetails
-
getTrailerNames
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
available
public final int available()Description copied from interface: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.- Specified by:
available
in interfaceAsyncDataProducer
- Returns:
- the number of bytes immediately available for output
-
produce
Description copied from interface: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.- Specified by:
produce
in interfaceAsyncDataProducer
- Parameters:
channel
- the data channel capable to accepting more data.- Throws:
IOException
-
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-