io.grpc

Class MethodDescriptor<ReqT,RespT>

java.lang.Object

io.grpc.MethodDescriptor<ReqT,RespT>

@Immutable
public class MethodDescriptor<ReqT,RespT>
extends Object

Description of a remote method used by Channel to initiate a call.

Provides the name of the operation to execute as well as MethodDescriptor.Marshaller instances used to parse and serialize request and response messages.

Can be constructed manually but will often be generated by stub code generators.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MethodDescriptor.Marshaller<T> A typed abstraction over message serialization and deserialization, a.k.a.
static class	MethodDescriptor.MethodType The call type of a method.

Method Summary

Modifier and Type	Method and Description
static <RequestT,ResponseT> MethodDescriptor<RequestT,ResponseT>	create(MethodDescriptor.MethodType type, String fullMethodName, MethodDescriptor.Marshaller<RequestT> requestMarshaller, MethodDescriptor.Marshaller<ResponseT> responseMarshaller) Creates a new MethodDescriptor.
static String	extractFullServiceName(String fullMethodName) Extract the fully qualified service name out of a fully qualified method name.
static String	generateFullMethodName(String fullServiceName, String methodName) Generate the fully qualified method name.
String	getFullMethodName() The fully qualified name of the method.
MethodDescriptor.MethodType	getType() The call type of the method.
boolean	isIdempotent() Returns whether this method is idempotent.
ReqT	parseRequest(InputStream input) Parse an incoming request message.
RespT	parseResponse(InputStream input) Parse a response payload from the given InputStream.
InputStream	streamRequest(ReqT requestMessage) Convert a request message to an InputStream.
InputStream	streamResponse(RespT response) Serialize an outgoing response message.
MethodDescriptor<ReqT,RespT>	withIdempotent(boolean idempotent) Set idempotency on this method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1774")
public static <RequestT,ResponseT> MethodDescriptor<RequestT,ResponseT> create(MethodDescriptor.MethodType type,
                                                                                                                                                       String fullMethodName,
                                                                                                                                                       MethodDescriptor.Marshaller<RequestT> requestMarshaller,
                                                                                                                                                       MethodDescriptor.Marshaller<ResponseT> responseMarshaller)

Creates a new MethodDescriptor.

Parameters:

type - the call type of this method

fullMethodName - the fully qualified name of this method

requestMarshaller - the marshaller used to encode and decode requests

responseMarshaller - the marshaller used to encode and decode responses

getType

public MethodDescriptor.MethodType getType()

The call type of the method.

getFullMethodName

public String getFullMethodName()

The fully qualified name of the method.

parseResponse

public RespT parseResponse(InputStream input)

Parse a response payload from the given InputStream.

Parameters:

input - stream containing response message to parse.

Returns:

parsed response message object.

streamRequest

public InputStream streamRequest(ReqT requestMessage)

Convert a request message to an InputStream.

Parameters:

requestMessage - to serialize using the request MethodDescriptor.Marshaller.

Returns:

serialized request message.

parseRequest

public ReqT parseRequest(InputStream input)

Parse an incoming request message.

Parameters:

input - the serialized message as a byte stream.

Returns:

a parsed instance of the message.

streamResponse

public InputStream streamResponse(RespT response)

Serialize an outgoing response message.

Parameters:

response - the response message to serialize.

Returns:

the serialized message as a byte stream.

isIdempotent

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1775")
public boolean isIdempotent()

Returns whether this method is idempotent.

withIdempotent

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1775")
public MethodDescriptor<ReqT,RespT> withIdempotent(boolean idempotent)

Set idempotency on this method.

Parameters:

idempotent - the idempotency of this method.

Returns:

a new copy of MethodDescriptor.

generateFullMethodName

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1774")
public static String generateFullMethodName(String fullServiceName,
                                                                                                                    String methodName)

Generate the fully qualified method name.

Parameters:

fullServiceName - the fully qualified service name that is prefixed with the package name

methodName - the short method name

extractFullServiceName

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1774")
 @Nullable
public static String extractFullServiceName(String fullMethodName)

Extract the fully qualified service name out of a fully qualified method name. May return null if the input is malformed, but you cannot rely on it for the validity of the input.