Module io.helidon.grpc.core

Package io.helidon.grpc.core

Interface MethodHandler<ReqT,RespT>

Type Parameters:

ReqT - the request type

RespT - the response type

All Superinterfaces:

io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.UnaryMethod<ReqT,RespT>

All Known Implementing Classes:

io.helidon.microprofile.grpc.core.AbstractMethodHandlerSupplier.AbstractHandler, BidirectionalMethodHandlerSupplier.AbstractServerStreamingHandler, BidirectionalMethodHandlerSupplier.BidiStreaming, ClientStreamingMethodHandlerSupplier.AbstractClientStreamingHandler, ClientStreamingMethodHandlerSupplier.ClientStreaming, ClientStreamingMethodHandlerSupplier.ClientStreamingIterable, ClientStreamingMethodHandlerSupplier.ClientStreamingStream, ClientStreamingMethodHandlerSupplier.FutureResponse, ServerStreamingMethodHandlerSupplier.AbstractServerStreamingHandler, ServerStreamingMethodHandlerSupplier.ServerStreaming, ServerStreamingMethodHandlerSupplier.ServerStreamingNoRequest, ServerStreamingMethodHandlerSupplier.StreamResponse, ServerStreamingMethodHandlerSupplier.StreamResponseNoRequest, UnaryMethodHandlerSupplier.AbstractUnaryHandler, UnaryMethodHandlerSupplier.FutureResponse, UnaryMethodHandlerSupplier.FutureResponseNoRequest, UnaryMethodHandlerSupplier.NoRequestNoResponse, UnaryMethodHandlerSupplier.RequestNoResponse, UnaryMethodHandlerSupplier.RequestResponse, UnaryMethodHandlerSupplier.ResponseOnly, UnaryMethodHandlerSupplier.Unary, UnaryMethodHandlerSupplier.UnaryFuture, UnaryMethodHandlerSupplier.UnaryFutureNoRequest, UnaryMethodHandlerSupplier.UnaryNoRequest

public interface MethodHandler<ReqT,RespT>
extends io.grpc.stub.ServerCalls.UnaryMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,RespT>, io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,RespT>

A gRPC method call handler.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MethodHandler.BidirectionalClient	A bidirectional client call handler.
static interface	MethodHandler.ClientStreaming	A client streaming client call handler.
static interface	MethodHandler.ServerStreamingClient	A server streaming client call handler.
static interface	MethodHandler.UnaryClient	A unary client call handler.

Method Summary

Modifier and Type	Method	Description
default Object	bidirectional(Object[] args, MethodHandler.BidirectionalClient client)	Handle a bi-directional client call.
default boolean	clientOnly()	Determine whether this is a client side only handler.
default Object	clientStreaming(Object[] args, MethodHandler.ClientStreaming client)	Handle a bi-directional client call.
Class<?>	getRequestType()	Obtain the request type.
Class<?>	getResponseType()	Obtain the response type.
default io.grpc.stub.StreamObserver<ReqT>	invoke(io.grpc.stub.StreamObserver<RespT> observer)
default void	invoke(ReqT request, io.grpc.stub.StreamObserver<RespT> observer)
String	javaMethodName()	Obtain the name of the underlying Java method that this handler maps to.
default Object	serverStreaming(Object[] args, MethodHandler.ServerStreamingClient client)	Handle a bi-directional client call.
io.grpc.MethodDescriptor.MethodType	type()	Obtain the gRPC method tyoe that this MethodHandler handles.
default Object	unary(Object[] args, MethodHandler.UnaryClient client)	Handle a bi-directional client call.

Method Detail

type

io.grpc.MethodDescriptor.MethodType type()

Obtain the gRPC method tyoe that this MethodHandler handles.

Returns:

the gRPC method type that this MethodHandler handles

getRequestType

Class<?> getRequestType()

Obtain the request type.

Returns:

the request type

getResponseType

Class<?> getResponseType()

Obtain the response type.

Returns:

the response type

javaMethodName

String javaMethodName()

Obtain the name of the underlying Java method that this handler maps to.

Returns:

the name of the underlying Java method that this handler maps to

clientOnly

default boolean clientOnly()

Determine whether this is a client side only handler.

Returns:

true if this handler can only be used on the client

invoke

default void invoke(ReqT request,
                    io.grpc.stub.StreamObserver<RespT> observer)

Specified by:

invoke in interface io.grpc.stub.ServerCalls.ServerStreamingMethod<ReqT,RespT>

Specified by:

invoke in interface io.grpc.stub.ServerCalls.UnaryMethod<ReqT,RespT>

invoke

default io.grpc.stub.StreamObserver<ReqT> invoke(io.grpc.stub.StreamObserver<RespT> observer)

Specified by:

invoke in interface io.grpc.stub.ServerCalls.BidiStreamingMethod<ReqT,RespT>

Specified by:

invoke in interface io.grpc.stub.ServerCalls.ClientStreamingMethod<ReqT,RespT>

bidirectional

default Object bidirectional(Object[] args,
                             MethodHandler.BidirectionalClient client)

Handle a bi-directional client call.

Parameters:

args - the call arguments.

client - the MethodHandler.BidirectionalClient instance to forward the call to.

Returns:

the call result

clientStreaming

default Object clientStreaming(Object[] args,
                               MethodHandler.ClientStreaming client)

Handle a bi-directional client call.

Parameters:

args - the call arguments.

client - the MethodHandler.ClientStreaming instance to forward the call to.

Returns:

the call result

serverStreaming

default Object serverStreaming(Object[] args,
                               MethodHandler.ServerStreamingClient client)

Handle a bi-directional client call.

Parameters:

args - the call arguments.

client - the MethodHandler.ServerStreamingClient instance to forward the call to.

Returns:

the call result

unary

default Object unary(Object[] args,
                     MethodHandler.UnaryClient client)

Handle a bi-directional client call.

Parameters:

args - the call arguments.

client - the MethodHandler.UnaryClient instance to forward the call to.

Returns:

the call result