Class ReactiveServerExchangeHandler

java.lang.Object
org.apache.hc.core5.reactive.ReactiveServerExchangeHandler
All Implemented Interfaces:
AsyncDataConsumer, AsyncDataExchangeHandler, AsyncDataProducer, AsyncServerExchangeHandler, ResourceHolder

public final class ReactiveServerExchangeHandler extends Object implements AsyncServerExchangeHandler
An implementation of AsyncServerExchangeHandler designed to work with reactive streams.
Since:
5.0
  • Field Details

  • Constructor Details

    • ReactiveServerExchangeHandler

      public ReactiveServerExchangeHandler(ReactiveRequestProcessor requestProcessor)
      Creates a ReactiveServerExchangeHandler.
      Parameters:
      requestProcessor - the ReactiveRequestProcessor instance to invoke when the request is ready to be handled.
  • Method Details

    • handleRequest

      public void handleRequest(HttpRequest request, EntityDetails entityDetails, ResponseChannel responseChannel, HttpContext context) throws HttpException, IOException
      Description copied from interface: AsyncServerExchangeHandler
      Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.
      Specified by:
      handleRequest in interface AsyncServerExchangeHandler
      Parameters:
      request - the actual request.
      entityDetails - the request entity details or null if the request does not enclose an entity.
      responseChannel - the response channel.
      context - the actual execution context.
      Throws:
      HttpException
      IOException
    • failed

      public void failed(Exception cause)
      Description copied from interface: AsyncDataExchangeHandler
      Triggered to signal a failure in data processing.
      Specified by:
      failed in interface AsyncDataExchangeHandler
      Parameters:
      cause - the cause of the failure.
    • updateCapacity

      public void updateCapacity(CapacityChannel capacityChannel) throws IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.
      Specified by:
      updateCapacity in interface AsyncDataConsumer
      Parameters:
      capacityChannel - the channel for capacity updates.
      Throws:
      IOException
    • consume

      public void consume(ByteBuffer src) throws IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.
      Specified by:
      consume in interface AsyncDataConsumer
      Parameters:
      src - data source.
      Throws:
      IOException
    • streamEnd

      public void streamEnd(List<? extends Header> trailers) throws HttpException, IOException
      Description copied from interface: AsyncDataConsumer
      Triggered to signal termination of the data stream.
      Specified by:
      streamEnd in interface AsyncDataConsumer
      Parameters:
      trailers - data stream trailers.
      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 interface AsyncDataProducer
      Returns:
      the number of bytes immediately available for output
    • 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.
      Specified by:
      produce in interface AsyncDataProducer
      Parameters:
      channel - the data channel capable to accepting more data.
      Throws:
      IOException
    • releaseResources

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