Package org.apache.http.nio.entity

Class EntityAsyncContentProducer

java.lang.Object

org.apache.http.nio.entity.EntityAsyncContentProducer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HttpAsyncContentProducer

public class EntityAsyncContentProducer
extends java.lang.Object
implements HttpAsyncContentProducer

Basic implementation of HttpAsyncContentProducer that relies on inefficient and potentially blocking I/O operation redirection through Channels.newChannel(java.io.InputStream).

Since:

4.2

Constructor Summary

Constructors

Constructor	Description
EntityAsyncContentProducer(HttpEntity entity)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isRepeatable()	Determines whether or not this producer is capable of producing its content more than once.
void	produceContent(ContentEncoder encoder, IOControl ioctrl)	Invoked to write out a chunk of content to the ContentEncoder.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityAsyncContentProducer

public EntityAsyncContentProducer(HttpEntity entity)

Method Detail

produceContent

public void produceContent(ContentEncoder encoder,
                           IOControl ioctrl)
                    throws java.io.IOException

Description copied from interface: HttpAsyncContentProducer

Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the entity is temporarily unable to produce more content.

When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

Please note that the ContentEncoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on other thread to resume output event notifications when more content is made available.

Specified by:

produceContent in interface HttpAsyncContentProducer

Parameters:

encoder - content encoder.

ioctrl - I/O control of the underlying connection.

Throws:

java.io.IOException

isRepeatable

public boolean isRepeatable()

Description copied from interface: HttpAsyncContentProducer

Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.

Specified by:

isRepeatable in interface HttpAsyncContentProducer

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object