Modifier and Type	Class and Description
public static class	MethodDescriptor.Builder<ReqT, RespT> A builder for a `MethodDescriptor`.
public static interface	MethodDescriptor.Marshaller< type of serializable message T> A typed abstraction over message serialization and deserialization, a.k.a. marshalling and unmarshalling.
public static enum	MethodDescriptor.MethodType The call type of a method.
public static interface	MethodDescriptor.PrototypeMarshaller<T> A marshaller that uses a fixed instance of the type it produces.
public static interface	MethodDescriptor.ReflectableMarshaller<T> A marshaller that supports retrieving it's type parameter `T` at runtime.

Modifier and Type	Field and Description
private final String	fullMethodName
private final boolean	idempotent
private final AtomicReferenceArray<Object>	rawMethodNames
private final MethodDescriptor.Marshaller<ReqT>	requestMarshaller
private final MethodDescriptor.Marshaller<RespT>	responseMarshaller
private final boolean	safe
private final boolean	sampledToLocalTracing
private final Object	schemaDescriptor
private final String	serviceName
private final MethodDescriptor.MethodType	type

Access	Constructor and Description
private	MethodDescriptor(MethodDescriptor.MethodType type, String fullMethodName, MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller, Object schemaDescriptor, boolean idempotent, boolean safe, boolean sampledToLocalTracing)

Method Summary

Modifier and Type	Method and Description
public static <RequestT, ResponseT> MethodDescriptor<RequestT, ResponseT>	create(MethodDescriptor.MethodType the call type of this method type, String the fully qualified name of this method fullMethodName, MethodDescriptor.Marshaller<RequestT> the marshaller used to encode and decode requests requestMarshaller, MethodDescriptor.Marshaller<ResponseT> the marshaller used to encode and decode responses responseMarshaller) Deprecated use `newBuilder()`. Creates a new `MethodDescriptor`.
public static String	extractBareMethodName(String fullMethodName) Extract the method name out of a fully qualified method name.
public static String	extractFullServiceName(String fullMethodName) Extract the fully qualified service name out of a fully qualified method name.
public static String	generateFullMethodName(String the fully qualified service name that is prefixed with the package name fullServiceName, String the short method name methodName) Generate the fully qualified method name.
public String	getBareMethodName() A convenience method for `extractBareMethodName(getFullMethodName())`.
public String	getFullMethodName() The fully qualified name of the method.
pack-priv final Object	Returns: a transport specific representation of the method name. getRawMethodName(int the unique ID of the transport, given by `InternalKnownTransport#ordinal`. transportOrdinal) Gets the cached "raw" method name for this Method Descriptor.
public MethodDescriptor.Marshaller<ReqT>	getRequestMarshaller() Returns the marshaller for the request type.
public MethodDescriptor.Marshaller<RespT>	getResponseMarshaller() Returns the marshaller for the response type.
public Object	getSchemaDescriptor() Returns the schema descriptor for this method.
public String	getServiceName() A convenience method for `extractFullServiceName(getFullMethodName())`.
public MethodDescriptor.MethodType	getType() The call type of the method.
public boolean	isIdempotent() Returns whether this method is idempotent.
public boolean	isSafe() Returns whether this method is safe.
public boolean	isSampledToLocalTracing() Returns whether RPCs for this method may be sampled into the local tracing store.
public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT>	newBuilder() Creates a new builder for a `MethodDescriptor`.
public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT>	newBuilder(MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller) Creates a new builder for a `MethodDescriptor`.
public ReqT	Returns: a parsed instance of the message. parseRequest(InputStream the serialized message as a byte stream. input) Parse an incoming request message.
public RespT	Returns: parsed response message object. parseResponse(InputStream stream containing response message to parse. input) Parse a response payload from the given `InputStream`.
pack-priv final void	setRawMethodName(int transportOrdinal, Object o) Safely, but weakly, sets the raw method name for this Method Descriptor.
public InputStream	Returns: serialized request message. streamRequest(ReqT to serialize using the request `Marshaller`. requestMessage) Convert a request message to an `InputStream`.
public InputStream	Returns: the serialized message as a byte stream. streamResponse(RespT the response message to serialize. response) Serialize an outgoing response message.
public MethodDescriptor.Builder<ReqT, RespT>	toBuilder() Turns this descriptor into a builder.
public <NewReqT, NewRespT> MethodDescriptor.Builder<NewReqT, NewRespT>	toBuilder(MethodDescriptor.Marshaller<NewReqT> requestMarshaller, MethodDescriptor.Marshaller<NewRespT> responseMarshaller) Turns this descriptor into a builder, replacing the request and response marshallers.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

fullMethodName	back to summary
private final String fullMethodName

idempotent	back to summary
private final boolean idempotent

rawMethodNames	back to summary
private final AtomicReferenceArray<Object> rawMethodNames

requestMarshaller	back to summary
private final MethodDescriptor.Marshaller<ReqT> requestMarshaller

responseMarshaller	back to summary
private final MethodDescriptor.Marshaller<RespT> responseMarshaller

safe	back to summary
private final boolean safe

sampledToLocalTracing	back to summary
private final boolean sampledToLocalTracing

schemaDescriptor	back to summary
private final Object schemaDescriptor Annotations @Nullable

serviceName	back to summary
private final String serviceName Annotations @Nullable

type	back to summary
private final MethodDescriptor.MethodType type

Constructor Detail

MethodDescriptor	back to summary
private MethodDescriptor(MethodDescriptor.MethodType type, String fullMethodName, MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller, Object schemaDescriptor, boolean idempotent, boolean safe, boolean sampledToLocalTracing)

Method Detail

create back to summary

create	back to summary
public static <RequestT, ResponseT> MethodDescriptor<RequestT, ResponseT> create(MethodDescriptor.MethodType type, String fullMethodName, MethodDescriptor.Marshaller<RequestT> requestMarshaller, MethodDescriptor.Marshaller<ResponseT> responseMarshaller) Deprecated use `newBuilder()`. Creates a new `MethodDescriptor`. Parameters type:MethodDescriptor.MethodType the call type of this method fullMethodName:String the fully qualified name of this method requestMarshaller:MethodDescriptor.Marshaller<RequestT> the marshaller used to encode and decode requests responseMarshaller:MethodDescriptor.Marshaller<ResponseT> the marshaller used to encode and decode responses Annotations @Deprecated Since 1.0.0

public static <RequestT, ResponseT> MethodDescriptor<RequestT, ResponseT> create(MethodDescriptor.MethodType type, String fullMethodName, MethodDescriptor.Marshaller<RequestT> requestMarshaller, MethodDescriptor.Marshaller<ResponseT> responseMarshaller)

Deprecated

use newBuilder().

Creates a new MethodDescriptor.

Parameters

type:MethodDescriptor.MethodType: the call type of this method
fullMethodName:String: the fully qualified name of this method
requestMarshaller:MethodDescriptor.Marshaller<RequestT>: the marshaller used to encode and decode requests
responseMarshaller:MethodDescriptor.Marshaller<ResponseT>: the marshaller used to encode and decode responses

Annotations

@Deprecated

Since

1.0.0

extractBareMethodName back to summary

extractBareMethodName	back to summary
public static String extractBareMethodName(String fullMethodName) Extract the method 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. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635 Since 1.33.0

public static String extractBareMethodName(String fullMethodName)

Extract the method 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.

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635

Since

1.33.0

extractFullServiceName back to summary

extractFullServiceName	back to summary
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. Annotations @Nullable Since 1.0.0

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.

Annotations

@Nullable

Since

1.0.0

generateFullMethodName	back to summary
public static String generateFullMethodName(String fullServiceName, String methodName) Generate the fully qualified method name. This matches the name Parameters fullServiceName:String the fully qualified service name that is prefixed with the package name methodName:String the short method name Since 1.0.0

generateFullMethodName

back to summary

public static String generateFullMethodName(String fullServiceName, String methodName)

Generate the fully qualified method name. This matches the name

Parameters

fullServiceName:String: the fully qualified service name that is prefixed with the package name
methodName:String: the short method name

Since

1.0.0

getBareMethodName back to summary

getBareMethodName	back to summary
public String getBareMethodName() A convenience method for `extractBareMethodName(getFullMethodName())`. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635 Since 1.33.0

public String getBareMethodName()

A convenience method for extractBareMethodName(getFullMethodName()).

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635

Since

1.33.0

getFullMethodName	back to summary
public String getFullMethodName() The fully qualified name of the method. Since 1.0.0

getFullMethodName

back to summary

public String getFullMethodName()

The fully qualified name of the method.

Since: 1.0.0

getRawMethodName back to summary

getRawMethodName	back to summary
pack-priv final Object getRawMethodName(int transportOrdinal) Gets the cached "raw" method name for this Method Descriptor. The raw name is transport specific, and should be set using `setRawMethodName` by the transport. Parameters transportOrdinal:int the unique ID of the transport, given by `InternalKnownTransport#ordinal`. Returns:Object a transport specific representation of the method name.

pack-priv final Object getRawMethodName(int transportOrdinal)

Gets the cached "raw" method name for this Method Descriptor. The raw name is transport specific, and should be set using setRawMethodName by the transport.

Parameters

transportOrdinal:int: the unique ID of the transport, given by InternalKnownTransport#ordinal.

Returns:Object

a transport specific representation of the method name.

getRequestMarshaller	back to summary
public MethodDescriptor.Marshaller<ReqT> getRequestMarshaller() Returns the marshaller for the request type. Allows introspection of the request marshaller. Since 1.1.0

getRequestMarshaller

back to summary

public MethodDescriptor.Marshaller<ReqT> getRequestMarshaller()

Returns the marshaller for the request type. Allows introspection of the request marshaller.

Since: 1.1.0

getResponseMarshaller	back to summary
public MethodDescriptor.Marshaller<RespT> getResponseMarshaller() Returns the marshaller for the response type. Allows introspection of the response marshaller. Since 1.1.0

getResponseMarshaller

back to summary

public MethodDescriptor.Marshaller<RespT> getResponseMarshaller()

Returns the marshaller for the response type. Allows introspection of the response marshaller.

Since: 1.1.0

getSchemaDescriptor back to summary

getSchemaDescriptor	back to summary
public Object getSchemaDescriptor() Returns the schema descriptor for this method. A schema descriptor is an object that is not used by gRPC core but includes information related to the service method. The type of the object is specific to the consumer, so both the code setting the schema descriptor and the code calling `getSchemaDescriptor()` must coordinate. For example, protobuf generated code sets this value, in order to be consumed by the server reflection service. See also: `io.grpc.protobuf.ProtoMethodDescriptorSupplier`. Annotations @Nullable Since 1.7.0

public Object getSchemaDescriptor()

Returns the schema descriptor for this method. A schema descriptor is an object that is not used by gRPC core but includes information related to the service method. The type of the object is specific to the consumer, so both the code setting the schema descriptor and the code calling getSchemaDescriptor() must coordinate. For example, protobuf generated code sets this value, in order to be consumed by the server reflection service. See also: io.grpc.protobuf.ProtoMethodDescriptorSupplier.

Annotations

@Nullable

Since

1.7.0

getServiceName back to summary

getServiceName	back to summary
public String getServiceName() A convenience method for `extractFullServiceName(getFullMethodName())`. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635 Since 1.21.0

public String getServiceName()

A convenience method for extractFullServiceName(getFullMethodName()).

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/5635

Since

1.21.0

getType	back to summary
public MethodDescriptor.MethodType getType() The call type of the method. Since 1.0.0

getType

back to summary

public MethodDescriptor.MethodType getType()

The call type of the method.

Since: 1.0.0

isIdempotent	back to summary
public boolean isIdempotent() Returns whether this method is idempotent. Since 1.0.0

isIdempotent

back to summary

public boolean isIdempotent()

Returns whether this method is idempotent.

Since: 1.0.0

isSafe	back to summary
public boolean isSafe() Returns whether this method is safe. A safe request does nothing except retrieval so it has no side effects on the server side. Since 1.1.0

isSafe

back to summary

public boolean isSafe()

Returns whether this method is safe.

A safe request does nothing except retrieval so it has no side effects on the server side.

Since: 1.1.0

isSampledToLocalTracing	back to summary
public boolean isSampledToLocalTracing() Returns whether RPCs for this method may be sampled into the local tracing store.

newBuilder back to summary

newBuilder	back to summary
public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT> newBuilder() Creates a new builder for a `MethodDescriptor`. Annotations @CheckReturnValue Since 1.1.0

public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT> newBuilder()

Creates a new builder for a MethodDescriptor.

Annotations

@CheckReturnValue

Since

1.1.0

newBuilder back to summary

newBuilder	back to summary
public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT> newBuilder(MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller) Creates a new builder for a `MethodDescriptor`. Annotations @CheckReturnValue Since 1.1.0

public static <ReqT, RespT> MethodDescriptor.Builder<ReqT, RespT> newBuilder(MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller)

Creates a new builder for a MethodDescriptor.

Annotations

@CheckReturnValue

Since

1.1.0

parseRequest	back to summary
public ReqT parseRequest(InputStream input) Parse an incoming request message. Parameters input:InputStream the serialized message as a byte stream. Returns:ReqT a parsed instance of the message. Since 1.0.0

parseRequest

back to summary

public ReqT parseRequest(InputStream input)

Parse an incoming request message.

Parameters

input:InputStream: the serialized message as a byte stream.

Returns:ReqT

a parsed instance of the message.

Since

1.0.0

parseResponse back to summary

parseResponse	back to summary
public RespT parseResponse(InputStream input) Parse a response payload from the given `InputStream`. Parameters input:InputStream stream containing response message to parse. Returns:RespT parsed response message object. Since 1.0.0

public RespT parseResponse(InputStream input)

Parse a response payload from the given InputStream.

Parameters

input:InputStream: stream containing response message to parse.

Returns:RespT

parsed response message object.

Since

1.0.0

setRawMethodName	back to summary
pack-priv final void setRawMethodName(int transportOrdinal, Object o) Safely, but weakly, sets the raw method name for this Method Descriptor. This should only be called by the transport. See `getRawMethodName` for more detail.

streamRequest back to summary

streamRequest	back to summary
public InputStream streamRequest(ReqT requestMessage) Convert a request message to an `InputStream`. The returned InputStream should be closed by the caller. Parameters requestMessage:ReqT to serialize using the request `Marshaller`. Returns:InputStream serialized request message. Since 1.0.0

public InputStream streamRequest(ReqT requestMessage)

Convert a request message to an InputStream. The returned InputStream should be closed by the caller.

Parameters

requestMessage:ReqT: to serialize using the request Marshaller.

Returns:InputStream

serialized request message.

Since

1.0.0

streamResponse	back to summary
public InputStream streamResponse(RespT response) Serialize an outgoing response message. The returned InputStream should be closed by the caller. Parameters response:RespT the response message to serialize. Returns:InputStream the serialized message as a byte stream. Since 1.0.0

streamResponse

back to summary

public InputStream streamResponse(RespT response)

Serialize an outgoing response message. The returned InputStream should be closed by the caller.

Parameters

response:RespT: the response message to serialize.

Returns:InputStream

the serialized message as a byte stream.

Since

1.0.0

toBuilder	back to summary
public MethodDescriptor.Builder<ReqT, RespT> toBuilder() Turns this descriptor into a builder. Annotations @CheckReturnValue Since 1.1.0

toBuilder

back to summary

public MethodDescriptor.Builder<ReqT, RespT> toBuilder()

Turns this descriptor into a builder.

Annotations

@CheckReturnValue

Since

1.1.0

toBuilder	back to summary
public <NewReqT, NewRespT> MethodDescriptor.Builder<NewReqT, NewRespT> toBuilder(MethodDescriptor.Marshaller<NewReqT> requestMarshaller, MethodDescriptor.Marshaller<NewRespT> responseMarshaller) Turns this descriptor into a builder, replacing the request and response marshallers. Annotations @CheckReturnValue Since 1.1.0

toBuilder

back to summary

public <NewReqT, NewRespT> MethodDescriptor.Builder<NewReqT, NewRespT> toBuilder(MethodDescriptor.Marshaller<NewReqT> requestMarshaller, MethodDescriptor.Marshaller<NewRespT> responseMarshaller)

Turns this descriptor into a builder, replacing the request and response marshallers.

Annotations

@CheckReturnValue

Since

1.1.0

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

io.grpc back to summary

public final Class MethodDescriptor.Builder<ReqT, RespT>

Class Inheritance

extends Object

java.lang.Object
io.grpc.MethodDescriptor.Builder

A builder for a MethodDescriptor.

Since: 1.1.0

Field Summary

Modifier and Type	Field and Description
private String	fullMethodName
private boolean	idempotent
private MethodDescriptor.Marshaller<ReqT>	requestMarshaller
private MethodDescriptor.Marshaller<RespT>	responseMarshaller
private boolean	safe
private boolean	sampledToLocalTracing
private Object	schemaDescriptor
private MethodDescriptor.MethodType	type

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public MethodDescriptor<ReqT, RespT>	build() Builds the method descriptor.
public MethodDescriptor.Builder<ReqT, RespT>	setFullMethodName(String fullMethodName) Sets the fully qualified (service and method) method name.
public MethodDescriptor.Builder<ReqT, RespT>	setIdempotent(boolean idempotent) Sets whether the method is idempotent.
public MethodDescriptor.Builder<ReqT, RespT>	setRequestMarshaller(MethodDescriptor.Marshaller<ReqT> the marshaller to use. requestMarshaller) Sets the request marshaller.
public MethodDescriptor.Builder<ReqT, RespT>	setResponseMarshaller(MethodDescriptor.Marshaller<RespT> the marshaller to use. responseMarshaller) Sets the response marshaller.
public MethodDescriptor.Builder<ReqT, RespT>	setSafe(boolean safe) Sets whether this method is safe.
public MethodDescriptor.Builder<ReqT, RespT>	setSampledToLocalTracing(boolean value) Sets whether RPCs for this method may be sampled into the local tracing store.
public MethodDescriptor.Builder<ReqT, RespT>	setSchemaDescriptor(Object an object that describes the service structure. Should be immutable. schemaDescriptor) Sets the schema descriptor for this builder.
public MethodDescriptor.Builder<ReqT, RespT>	setType(MethodDescriptor.MethodType the type of the method. type) Sets the method type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

fullMethodName	back to summary
private String fullMethodName

idempotent	back to summary
private boolean idempotent

requestMarshaller	back to summary
private MethodDescriptor.Marshaller<ReqT> requestMarshaller

responseMarshaller	back to summary
private MethodDescriptor.Marshaller<RespT> responseMarshaller

safe	back to summary
private boolean safe

sampledToLocalTracing	back to summary
private boolean sampledToLocalTracing

schemaDescriptor	back to summary
private Object schemaDescriptor

type	back to summary
private MethodDescriptor.MethodType type

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build

back to summary

public MethodDescriptor<ReqT, RespT> build()

Builds the method descriptor.

Annotations

@CheckReturnValue

Since

1.1.0

setFullMethodName back to summary

public MethodDescriptor.Builder<ReqT, RespT> setFullMethodName(String fullMethodName)

Sets the fully qualified (service and method) method name.

Since: 1.1.0
See Also: MethodDescriptor#generateFullMethodName

setIdempotent back to summary

public MethodDescriptor.Builder<ReqT, RespT> setIdempotent(boolean idempotent)

Sets whether the method is idempotent. If true, calling this method more than once doesn't have additional side effects. If false, method is also not safe. Note that implies calling builder.setIdempotent(false).setIdempotent(true) will leave isSafe() == false.

Since: 1.1.0

setRequestMarshaller

back to summary

public MethodDescriptor.Builder<ReqT, RespT> setRequestMarshaller(MethodDescriptor.Marshaller<ReqT> requestMarshaller)

Sets the request marshaller.

Parameters

requestMarshaller:MethodDescriptor.Marshaller<ReqT>: the marshaller to use.

Since

1.1.0

setResponseMarshaller

back to summary

public MethodDescriptor.Builder<ReqT, RespT> setResponseMarshaller(MethodDescriptor.Marshaller<RespT> responseMarshaller)

Sets the response marshaller.

Parameters

responseMarshaller:MethodDescriptor.Marshaller<RespT>: the marshaller to use.

Since

1.1.0

setSafe back to summary

public MethodDescriptor.Builder<ReqT, RespT> setSafe(boolean safe)

Sets whether this method is safe. If true, calling this method any number of times doesn't have side effects. If true, method is also idempotent. Note that implies calling builder.setSafe(true).setSafe(false) will leave isIdempotent() == true.

Since: 1.1.0

setSampledToLocalTracing

back to summary

public MethodDescriptor.Builder<ReqT, RespT> setSampledToLocalTracing(boolean value)

Sets whether RPCs for this method may be sampled into the local tracing store. If true, sampled traces of this method may be kept in memory by tracing libraries.

Since: 1.8.0

setSchemaDescriptor back to summary

public MethodDescriptor.Builder<ReqT, RespT> setSchemaDescriptor(Object schemaDescriptor)

Sets the schema descriptor for this builder. A schema descriptor is an object that is not used by gRPC core but includes information related to the methods. The type of the object is specific to the consumer, so both the code calling this and the code calling MethodDescriptor#getSchemaDescriptor() must coordinate.

Parameters

schemaDescriptor:Object: an object that describes the service structure. Should be immutable.

Since

1.7.0

setType

back to summary

public MethodDescriptor.Builder<ReqT, RespT> setType(MethodDescriptor.MethodType type)

Sets the method type.

Parameters

type:MethodDescriptor.MethodType: the type of the method.

Since

1.1.0

io.grpc back to summary

public Interface MethodDescriptor.Marshaller<T>

Known Direct Subinterfaces

io.grpc.MethodDescriptor.ReflectableMarshaller

Type Parameters

<T>: type of serializable message

A typed abstraction over message serialization and deserialization, a.k.a. marshalling and unmarshalling.

Stub implementations will define implementations of this interface for each of the request and response messages provided by a service.

Since: 1.0.0

Method Summary

Modifier and Type	Method and Description
public T	Returns: parsed value parse(InputStream of bytes for serialized value stream) Given an `InputStream` parse it into an instance of the declared type so that it can be passed to application code.
public InputStream	Returns: serialized value as stream of bytes. stream(T to serialize. value) Given a message, produce an `InputStream` for it so that it can be written to the wire.

Method Detail

parse back to summary

public T parse(InputStream stream)

Given an InputStream parse it into an instance of the declared type so that it can be passed to application code.

Parameters

stream:InputStream: of bytes for serialized value

Returns:T

parsed value

stream back to summary

public InputStream stream(T value)

Given a message, produce an InputStream for it so that it can be written to the wire. Where possible implementations should produce streams that are io.grpc.KnownLength to improve transport efficiency.

Parameters

value:T: to serialize.

Returns:InputStream

serialized value as stream of bytes.

io.grpc back to summary

public final Enum MethodDescriptor.MethodType

Class Inheritance

extends Enum<MethodDescriptor.MethodType>

java.lang.Object
java.lang.Enum
io.grpc.MethodDescriptor.MethodType

The call type of a method.

Since: 1.0.0

Field Summary

Modifier and Type	Field and Description
public static final MethodDescriptor.MethodType	BIDI_STREAMING Zero or more request and response messages arbitrarily interleaved in time.
public static final MethodDescriptor.MethodType	CLIENT_STREAMING Zero or more request messages with one response message.
public static final MethodDescriptor.MethodType	SERVER_STREAMING One request message followed by zero or more response messages.
public static final MethodDescriptor.MethodType	UNARY One request message followed by one response message.
public static final MethodDescriptor.MethodType	UNKNOWN Cardinality and temporal relationships are not known.

Constructor Summary

Access	Constructor and Description
private	MethodType()

Method Summary

Modifier and Type	Method and Description
public final boolean	clientSendsOneMessage() Returns `true` for `UNARY` and `SERVER_STREAMING`, which do not permit the client to stream.
public final boolean	serverSendsOneMessage() Returns `true` for `UNARY` and `CLIENT_STREAMING`, which do not permit the server to stream.
public static MethodDescriptor.MethodType	valueOf(String name)
public static MethodDescriptor.MethodType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BIDI_STREAMING	back to summary
public static final MethodDescriptor.MethodType BIDI_STREAMING Zero or more request and response messages arbitrarily interleaved in time.

CLIENT_STREAMING	back to summary
public static final MethodDescriptor.MethodType CLIENT_STREAMING Zero or more request messages with one response message.

SERVER_STREAMING	back to summary
public static final MethodDescriptor.MethodType SERVER_STREAMING One request message followed by zero or more response messages.

UNARY	back to summary
public static final MethodDescriptor.MethodType UNARY One request message followed by one response message.

UNKNOWN	back to summary
public static final MethodDescriptor.MethodType UNKNOWN Cardinality and temporal relationships are not known. Implementations should not make buffering assumptions and should largely treat the same as `BIDI_STREAMING`.

Constructor Detail

MethodType	back to summary
private MethodType()

Method Detail

clientSendsOneMessage back to summary

public final boolean clientSendsOneMessage()

Returns true for UNARY and SERVER_STREAMING, which do not permit the client to stream.

Since: 1.0.0

serverSendsOneMessage back to summary

public final boolean serverSendsOneMessage()

Returns true for UNARY and CLIENT_STREAMING, which do not permit the server to stream.

Since: 1.0.0

valueOf	back to summary
public static MethodDescriptor.MethodType valueOf(String name)

values	back to summary
public static MethodDescriptor.MethodType[] values()

public final Class MethodDescriptor<ReqT, RespT>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class MethodDescriptor.Builder<ReqT, RespT>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface MethodDescriptor.Marshaller<T>

Method Summary

Method Detail

public final Enum MethodDescriptor.MethodType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface MethodDescriptor.PrototypeMarshaller<T>

Method Summary

Method Detail

public Interface MethodDescriptor.ReflectableMarshaller<T>

Method Summary

Method Detail