Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.nio.support.BasicPushProducer

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

Access	Constructor and Description
public	BasicPushProducer(final HttpResponse response, final AsyncEntityProducer dataProducer)
public	BasicPushProducer(final int code, final AsyncEntityProducer dataProducer)
public	BasicPushProducer(final AsyncEntityProducer dataProducer)

Method Summary

Modifier and Type	Method and Description
public int	available() Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available. Returns the number of bytes immediately available for output.
public void	failed(final Exception the cause of the failure. cause) Implements org.apache.hc.core5.http.nio.AsyncPushProducer.failed. Triggered to signal a failure in data generation.
public void	produce(final DataStreamChannel the data channel capable to accepting more data. channel) Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce. Triggered to signal the ability of the underlying data channel to accept more data.
public void	produceResponse(final ResponseChannel the response channel capable to accepting response messages. channel, final HttpContext the actual execution context. httpContext) Implements org.apache.hc.core5.http.nio.AsyncPushProducer.produceResponse. Triggered to signal the ability of the underlying response channel to accept response messages.
public void	releaseResources() Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dataProducer	back to summary
private final AsyncEntityProducer dataProducer

response	back to summary
private final HttpResponse response

BasicPushProducer	back to summary
public BasicPushProducer(final HttpResponse response, final AsyncEntityProducer dataProducer)

BasicPushProducer	back to summary
public BasicPushProducer(final int code, final AsyncEntityProducer dataProducer)

BasicPushProducer	back to summary
public BasicPushProducer(final AsyncEntityProducer dataProducer)

Method Detail

available	back to summary
public int available() Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available. Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.available. 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:int the number of bytes immediately available for output Annotations @Override

available

back to summary

public int available()

Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available.

Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.available.

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

the number of bytes immediately available for output

Annotations

@Override

failed	back to summary
public void failed(final Exception cause) Implements org.apache.hc.core5.http.nio.AsyncPushProducer.failed. Doc from org.apache.hc.core5.http.nio.AsyncPushProducer.failed. Triggered to signal a failure in data generation. Parameters cause:Exception the cause of the failure. Annotations @Override

failed

back to summary

public void failed(final Exception cause)

Implements org.apache.hc.core5.http.nio.AsyncPushProducer.failed.

Doc from org.apache.hc.core5.http.nio.AsyncPushProducer.failed.

Triggered to signal a failure in data generation.

Parameters

cause:Exception: the cause of the failure.

Annotations

@Override

produce	back to summary
public void produce(final DataStreamChannel channel) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce. Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.produce. 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. Parameters channel:DataStreamChannel the data channel capable to accepting more data. Annotations @Override

produce

back to summary

public void produce(final DataStreamChannel channel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce.

Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.produce.

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.

Parameters

channel:DataStreamChannel: the data channel capable to accepting more data.

Annotations

@Override

produceResponse	back to summary
public void produceResponse(final ResponseChannel channel, final HttpContext httpContext) throws HttpException, IOException Implements org.apache.hc.core5.http.nio.AsyncPushProducer.produceResponse. Doc from org.apache.hc.core5.http.nio.AsyncPushProducer.produceResponse. 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. Parameters channel:ResponseChannel the response channel capable to accepting response messages. httpContext:HttpContext the actual execution context. Annotations @Override

produceResponse

back to summary

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

Implements org.apache.hc.core5.http.nio.AsyncPushProducer.produceResponse.

Doc from org.apache.hc.core5.http.nio.AsyncPushProducer.produceResponse.

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.

Parameters