io.servicetalk.grpc.api

Interface GrpcRoutes.BlockingStreamingRoute<Req,Resp>

Type Parameters:

Req - Type of request.

Resp - Type of response.

All Superinterfaces:

AutoCloseable, GracefulAutoCloseable

Enclosing class:

GrpcRoutes<Service extends GrpcService>

Functional Interface:

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

@FunctionalInterface
protected static interface GrpcRoutes.BlockingStreamingRoute<Req,Resp>
extends GracefulAutoCloseable

A blocking gRPC route with bi-directional streaming.

Method Summary

Modifier and Type	Method and Description
default void	close()
default void	handle(GrpcServiceContext ctx, BlockingIterable<Req> request, BlockingStreamingGrpcServerResponse<Resp> response) Handles the passed Req.
void	handle(GrpcServiceContext ctx, BlockingIterable<Req> request, GrpcPayloadWriter<Resp> responseWriter) Deprecated. Use handle(GrpcServiceContext, BlockingIterable, BlockingStreamingGrpcServerResponse). In the next release, this method will have a default implementation but the new overload won't. To avoid breaking API changes, make sure to implement both methods. The release after next will remove this method. This intermediate step is necessary to maintain FunctionalInterface contract that requires to have a single non-default method. Note: if you also use wrap(GrpcRoutes.BlockingStreamingRoute, GracefulAutoCloseable) method, make sure to pass there an implementation of GrpcRoutes.BlockingStreamingRoute that implements both overloads instead of a lambda. Otherwise, the default handle(GrpcServiceContext, BlockingIterable, BlockingStreamingGrpcServerResponse) implementation will be used.
static <Req,Resp> GrpcRoutes.BlockingStreamingRoute<Req,Resp>	wrap(GrpcRoutes.BlockingStreamingRoute<Req,Resp> rawRoute, GracefulAutoCloseable closeable) Convenience method to wrap a raw GrpcRoutes.BlockingStreamingRoute instance with a passed detached close implementation of GracefulAutoCloseable.

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Method Detail

handle

@Deprecated
void handle(GrpcServiceContext ctx,
                        BlockingIterable<Req> request,
                        GrpcPayloadWriter<Resp> responseWriter)
                 throws Exception

Deprecated. Use handle(GrpcServiceContext, BlockingIterable, BlockingStreamingGrpcServerResponse). In the next release, this method will have a default implementation but the new overload won't. To avoid breaking API changes, make sure to implement both methods. The release after next will remove this method. This intermediate step is necessary to maintain FunctionalInterface contract that requires to have a single non-default method. Note: if you also use wrap(GrpcRoutes.BlockingStreamingRoute, GracefulAutoCloseable) method, make sure to pass there an implementation of GrpcRoutes.BlockingStreamingRoute that implements both overloads instead of a lambda. Otherwise, the default handle(GrpcServiceContext, BlockingIterable, BlockingStreamingGrpcServerResponse) implementation will be used.

Handles the passed Req.

Parameters:

ctx - GrpcServiceContext for this call.

request - BlockingIterable of Req to handle.

responseWriter - GrpcPayloadWriter to write the response. The implementation of this method is responsible for calling Closeable.close().

Throws:

Exception - If an exception occurs during request processing.

handle

default void handle(GrpcServiceContext ctx,
                    BlockingIterable<Req> request,
                    BlockingStreamingGrpcServerResponse<Resp> response)
             throws Exception

Handles the passed Req.

Parameters:

ctx - GrpcServiceContext for this call.

request - BlockingIterable of Req to handle.

response - BlockingStreamingGrpcServerResponse to send the response. The implementation of this method is responsible for calling Closeable.close().

Throws:

Exception - If an exception occurs during request processing.

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

wrap

static <Req,Resp> GrpcRoutes.BlockingStreamingRoute<Req,Resp> wrap(GrpcRoutes.BlockingStreamingRoute<Req,Resp> rawRoute,
                                                                   GracefulAutoCloseable closeable)

Convenience method to wrap a raw GrpcRoutes.BlockingStreamingRoute instance with a passed detached close implementation of GracefulAutoCloseable.

Note: make sure to pass there an implementation of GrpcRoutes.BlockingStreamingRoute that implements both overloads instead of a lambda. Otherwise, the default handle(GrpcServiceContext, BlockingIterable, BlockingStreamingGrpcServerResponse) implementation will be used.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

rawRoute - GrpcRoutes.BlockingStreamingRoute instance that has a detached close implementation.

closeable - GracefulAutoCloseable implementation for the passed rawRoute.

Returns:

A new GrpcRoutes.BlockingStreamingRoute that attaches the passed closeable to the passed rawRoute.