Class BasicResponseProducer
java.lang.Object
org.apache.hc.core5.http.nio.support.BasicResponseProducer
- All Implemented Interfaces:
AsyncDataProducer
,AsyncResponseProducer
,ResourceHolder
Basic implementation of
AsyncResponseProducer
that produces one fixed response
and relies on a AsyncEntityProducer
to generate response entity stream.- Since:
- 5.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBasicResponseProducer
(int code, String message) BasicResponseProducer
(int code, String message, ContentType contentType) BasicResponseProducer
(int code, AsyncEntityProducer dataProducer) BasicResponseProducer
(HttpResponse response) BasicResponseProducer
(HttpResponse response, String message) BasicResponseProducer
(HttpResponse response, String message, ContentType contentType) BasicResponseProducer
(HttpResponse response, AsyncEntityProducer dataProducer) BasicResponseProducer
(AsyncEntityProducer dataProducer) -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of bytes immediately available for output.void
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
void
sendResponse
(ResponseChannel responseChannel, HttpContext httpContext) Triggered to signal the ability of the underlying response channel to accept response messages.
-
Field Details
-
response
-
dataProducer
-
-
Constructor Details
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
BasicResponseProducer
-
-
Method Details
-
sendResponse
public void sendResponse(ResponseChannel responseChannel, HttpContext httpContext) throws HttpException, IOException Description copied from interface:AsyncResponseProducer
Triggered to signal the ability of the underlying response channel to accept response messages. The data producer can choose to send response messages immediately inside the call or asynchronously at some later point.- Specified by:
sendResponse
in interfaceAsyncResponseProducer
- Parameters:
responseChannel
- the response channel capable to accepting response messages.httpContext
- the actual execution context.- Throws:
HttpException
IOException
-
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.- 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
-
failed
Description copied from interface:AsyncResponseProducer
Triggered to signal a failure in data generation.- Specified by:
failed
in interfaceAsyncResponseProducer
- Parameters:
cause
- the cause of the failure.
-
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-