io.servicetalk.http.api

Interface BlockingStreamingHttpService

All Superinterfaces:

AutoCloseable, ExecutionStrategyInfluencer<HttpExecutionStrategy>, GracefulAutoCloseable, HttpExecutionStrategyInfluencer, HttpServiceBase

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface BlockingStreamingHttpService
extends HttpServiceBase, GracefulAutoCloseable

The equivalent of StreamingHttpService but with synchronous/blocking APIs instead of asynchronous APIs.

Method Summary

Modifier and Type	Method and Description
default void	close()
void	handle(HttpServiceContext ctx, BlockingStreamingHttpRequest request, BlockingStreamingHttpServerResponse response) Handles a single HTTP request.
default HttpExecutionStrategy	requiredOffloads()

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Method Detail

handle

void handle(HttpServiceContext ctx,
            BlockingStreamingHttpRequest request,
            BlockingStreamingHttpServerResponse response)
     throws Exception

Handles a single HTTP request.

Parameters:

ctx - Context of the service.

request - to handle.

response - to send to the client. The implementation of this method is responsible for closing HttpPayloadWriter or HttpOutputStream after meta-data is sent and payload body is written.

Throws:

Exception - If an exception occurs during request processing.

requiredOffloads

default HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception