io.grpc

Enum MethodDescriptor.MethodType

java.lang.Object

java.lang.Enum<MethodDescriptor.MethodType>

io.grpc.MethodDescriptor.MethodType

All Implemented Interfaces:

Serializable, Comparable<MethodDescriptor.MethodType>

Enclosing class:

MethodDescriptor<ReqT,RespT>

public static enum MethodDescriptor.MethodType
extends Enum<MethodDescriptor.MethodType>

The call type of a method.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIDI_STREAMING Zero or more request and response messages arbitrarily interleaved in time.
CLIENT_STREAMING Zero or more request messages followed by one response message.
SERVER_STREAMING One request message followed by zero or more response messages.
UNARY One request message followed by one response message.
UNKNOWN Cardinality and temporal relationships are not known.

Method Summary

Modifier and Type	Method and Description
boolean	clientSendsOneMessage() Returns true if the client will immediately send one request message to the server after calling ClientCall.start(io.grpc.ClientCall.Listener, io.grpc.Metadata) and then immediately half-close the stream by calling ClientCall.halfClose().
boolean	serverSendsOneMessage() Returns true if the server will immediately send one response message to the client upon receipt of ServerCall.Listener.onHalfClose() and then immediately close the stream by calling ServerCall.close(Status, io.grpc.Metadata).
static MethodDescriptor.MethodType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MethodDescriptor.MethodType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNARY

public static final MethodDescriptor.MethodType UNARY

One request message followed by one response message.

CLIENT_STREAMING

public static final MethodDescriptor.MethodType CLIENT_STREAMING

Zero or more request messages followed by one response message.

SERVER_STREAMING

public static final MethodDescriptor.MethodType SERVER_STREAMING

One request message followed by zero or more response messages.

BIDI_STREAMING

public static final MethodDescriptor.MethodType BIDI_STREAMING

Zero or more request and response messages arbitrarily interleaved in time.

UNKNOWN

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.

Method Detail

values

public static MethodDescriptor.MethodType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MethodDescriptor.MethodType c : MethodDescriptor.MethodType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MethodDescriptor.MethodType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

clientSendsOneMessage

public final boolean clientSendsOneMessage()

Returns true if the client will immediately send one request message to the server after calling ClientCall.start(io.grpc.ClientCall.Listener, io.grpc.Metadata) and then immediately half-close the stream by calling ClientCall.halfClose().

Since:

1.0.0

serverSendsOneMessage

public final boolean serverSendsOneMessage()

Returns true if the server will immediately send one response message to the client upon receipt of ServerCall.Listener.onHalfClose() and then immediately close the stream by calling ServerCall.close(Status, io.grpc.Metadata).

Since:

1.0.0