io.grpc

Class MethodDescriptor<RequestT,ResponseT>

java.lang.Object

io.grpc.MethodDescriptor<RequestT,ResponseT>

@Immutable
public class MethodDescriptor<RequestT,ResponseT>
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 Marshaller instances used to parse and serialize request and response messages.

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

Method Summary

Modifier and Type	Method and Description
static <RequestT,ResponseT> MethodDescriptor<RequestT,ResponseT>	create(MethodType type, String name, long timeout, TimeUnit timeoutUnit, Marshaller<RequestT> requestMarshaller, Marshaller<ResponseT> responseMarshaller)
String	getName() The fully qualified name of the method.
long	getTimeout() Timeout for the operation in microseconds.
MethodType	getType() The call type of the method.
ResponseT	parseResponse(InputStream input) Parse a response payload from the given InputStream.
InputStream	streamRequest(RequestT requestMessage) Convert a request message to an InputStream.
MethodDescriptor<RequestT,ResponseT>	withTimeout(long timeout, TimeUnit unit) Create a new descriptor with a different timeout.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <RequestT,ResponseT> MethodDescriptor<RequestT,ResponseT> create(MethodType type,
                                                                               String name,
                                                                               long timeout,
                                                                               TimeUnit timeoutUnit,
                                                                               Marshaller<RequestT> requestMarshaller,
                                                                               Marshaller<ResponseT> responseMarshaller)

getType

public MethodType getType()

The call type of the method.

getName

public String getName()

The fully qualified name of the method.

getTimeout

public long getTimeout()

Timeout for the operation in microseconds.

parseResponse

public ResponseT 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(RequestT requestMessage)

Convert a request message to an InputStream.

Parameters:

requestMessage - to serialize using the request Marshaller.

Returns:

serialized request message.

withTimeout

public MethodDescriptor<RequestT,ResponseT> withTimeout(long timeout,
                                                        TimeUnit unit)

Create a new descriptor with a different timeout.

Parameters:

timeout - to set on cloned descriptor.

unit - of time for timeout.

Returns:

a cloned instance with the specified timeout set.