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

Class AbstractBinAsyncEntityProducer

java.lang.Object
org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityProducer
All Implemented Interfaces:
EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder
@Contract(threading=SAFE_CONDITIONAL) public abstract class AbstractBinAsyncEntityProducer extends Object implements AsyncEntityProducer
Abstract binary entity content producer.
Since:
5.0

  • Constructor Details

    • AbstractBinAsyncEntityProducer

      public AbstractBinAsyncEntityProducer(int fragmentSizeHint, ContentType contentType)

  • Method Details

    • 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

      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.

      Parameters:
      channel - the data channel capable to accepting more data.
      Throws:
      IOException - in case of an I/O error.

    • getContentType

      public final String getContentType()
      Description copied from interface: EntityDetails
      Gets content type of this entity, if known.
      Specified by:
      getContentType in interface EntityDetails
      Returns:
      the content type of this entity, may be null.

    • getContentEncoding

      public String getContentEncoding()
      Description copied from interface: EntityDetails
      Gets content encoding of this entity, if known.
      Specified by:
      getContentEncoding in interface EntityDetails
      Returns:
      the content encoding of this entity, may be null.

    • isChunked

      public boolean isChunked()
      Description copied from interface: EntityDetails
      Tests the chunked transfer hint for this entity.

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

      Specified by:
      isChunked in interface EntityDetails
      Returns:
      the chunked transfer hint for this entity.

    • getTrailerNames

      public Set<String> getTrailerNames()
      Description copied from interface: EntityDetails
      Gets the preliminary declaration of trailing headers.
      Specified by:
      getTrailerNames in interface EntityDetails
      Returns:
      the preliminary declaration of trailing headers.

    • getContentLength

      public long getContentLength()
      Description copied from interface: EntityDetails
      Gets length of this entity, if known.
      Specified by:
      getContentLength in interface EntityDetails
      Returns:
      the length of this entity, may be 0.

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

      Please note this method should return zero if the data producer is unable to produce any more data, in which case AsyncDataProducer.produce(DataStreamChannel) method will not get triggered. The producer can resume writing out data asynchronously once more data becomes available or request output readiness events with DataStreamChannel.requestOutput().

      Specified by:
      available in interface AsyncDataProducer
      Returns:
      the number of bytes immediately available for output
      See Also:

    • produce

      public final void produce(DataStreamChannel channel) throws IOException
      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.

      Please note this method gets triggered only if AsyncDataProducer.available() returns a positive value.

      Specified by:
      produce in interface AsyncDataProducer
      Parameters:
      channel - the data channel capable of accepting more data.
      Throws:
      IOException - in case of an I/O error.
      See Also:

    • releaseResources

      public void releaseResources()
      Specified by:
      releaseResources in interface ResourceHolder