Class BasicPushProducer

java.lang.Object

org.apache.hc.core5.http.nio.support.BasicPushProducer

All Implemented Interfaces:

AsyncDataProducer, AsyncPushProducer, ResourceHolder

public class BasicPushProducer
extends Object
implements AsyncPushProducer

Basic implementation of AsyncPushProducer that produces one fixed response and relies on a AsyncEntityProducer to generate response entity stream.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private final AsyncEntityProducer	dataProducer
private final HttpResponse	response

Constructor Summary

Constructors

Constructor	Description
BasicPushProducer(int code, AsyncEntityProducer dataProducer)
BasicPushProducer(HttpResponse response, AsyncEntityProducer dataProducer)
BasicPushProducer(AsyncEntityProducer dataProducer)

Method Summary

Modifier and Type	Method	Description
int	available()	Returns the number of bytes immediately available for output.
void	failed(Exception cause)	Triggered to signal a failure in data generation.
void	produce(DataStreamChannel channel)	Triggered to signal the ability of the underlying data channel to accept more data.
void	produceResponse(ResponseChannel channel, HttpContext httpContext)	Triggered to signal the ability of the underlying response channel to accept response messages.
void	releaseResources()

Methods inherited from class Object

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

Field Details

response

private final HttpResponse response

dataProducer

private final AsyncEntityProducer dataProducer

Constructor Details

BasicPushProducer

public BasicPushProducer(HttpResponse response,
 AsyncEntityProducer dataProducer)

BasicPushProducer

public BasicPushProducer(int code,
 AsyncEntityProducer dataProducer)

BasicPushProducer

public BasicPushProducer(AsyncEntityProducer dataProducer)

Method Details

produceResponse

public void produceResponse(ResponseChannel channel,
 HttpContext httpContext)
                     throws HttpException,
IOException

Description copied from interface: AsyncPushProducer

Triggered to signal the ability of the underlying response channel to accept response messages. The data producer can choose to send a final response message immediately inside the call or asynchronously at some later point. The final response can be preceded by a number of intermediate messages.

Specified by:

produceResponse in interface AsyncPushProducer

Parameters:

channel - the response channel capable to accepting response messages.

httpContext - the actual execution context.

Throws:

HttpException - in case of an HTTP protocol violation.

IOException - in case of an I/O error.

available

public 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:

• AsyncDataProducer.produce(DataStreamChannel)
• DataStreamChannel.requestOutput()

produce

public 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:

• AsyncDataProducer.available()

failed

public void failed(Exception cause)

Description copied from interface: AsyncPushProducer

Triggered to signal a failure in data generation.

Specified by:

failed in interface AsyncPushProducer

Parameters:

cause - the cause of the failure.

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder