io.vertx.grpc.client

Interface GrpcClientRequest<Req,Resp>

All Superinterfaces:

GrpcWriteStream<Req>, StreamBase, WriteStream<Req>

public interface GrpcClientRequest<Req,Resp>
extends GrpcWriteStream<Req>

A request to a gRPC server.

You interact with the remote service with gRPC generated messages or protobuf encoded messages.

Before sending a request you need to set #serviceName) and #methodName) or alternatively the service fullMethodName(java.lang.String).

Writing a request message will send the request to the service:

• To send a unary request, just call #end(Req)
• To send a streaming request, call #write(Req) any time you need and then WriteStream.end()

Method Summary

Modifier and Type	Method and Description
io.vertx.core.http.HttpConnection	connection()
GrpcClientRequest<Req,Resp>	drainHandler(Handler<Void> handler)
GrpcClientRequest<Req,Resp>	encoding(String encoding)
GrpcClientRequest<Req,Resp>	exceptionHandler(Handler<Throwable> handler)
GrpcClientRequest<Req,Resp>	fullMethodName(String fullMethodName) Set the full method name to call, it must follow the format package-name + '.' + service-name + '/' + method-name or an IllegalArgumentException is thrown.
GrpcClientRequest<Req,Resp>	idleTimeout(long timeout) Sets the amount of time after which, if the request does not return any data within the timeout period, the request/response is cancelled and the related futures.
GrpcClientRequest<Req,Resp>	methodName(String methodName) Set the method name to call.
Future<GrpcClientResponse<Req,Resp>>	response()
default Future<GrpcClientResponse<Req,Resp>>	send(ReadStream<Req> body)
default Future<GrpcClientResponse<Req,Resp>>	send(Req item)
GrpcClientRequest<Req,Resp>	serviceName(ServiceName serviceName) Set the service name to call.
GrpcClientRequest<Req,Resp>	setWriteQueueMaxSize(int maxSize)

Methods inherited from interface io.vertx.grpc.common.GrpcWriteStream

cancel, endMessage, headers, writeMessage

Methods inherited from interface io.vertx.core.streams.WriteStream

end, end, end, end, write, write, writeQueueFull

Method Detail

encoding

GrpcClientRequest<Req,Resp> encoding(String encoding)

Specified by:

encoding in interface GrpcWriteStream<Req>

fullMethodName

GrpcClientRequest<Req,Resp> fullMethodName(String fullMethodName)

Set the full method name to call, it must follow the format package-name + '.' + service-name + '/' + method-name or an IllegalArgumentException is thrown.

It must be called before sending the request otherwise an IllegalStateException is thrown.

Parameters:

fullMethodName - the full method name to call

Returns:

a reference to this, so the API can be used fluently

serviceName

GrpcClientRequest<Req,Resp> serviceName(ServiceName serviceName)

Set the service name to call.

It must be called before sending the request otherwise an IllegalStateException is thrown.

Parameters:

serviceName - the service name to call

Returns:

a reference to this, so the API can be used fluently

methodName

GrpcClientRequest<Req,Resp> methodName(String methodName)

Set the method name to call.

It must be called before sending the request otherwise an IllegalStateException is thrown.

Parameters:

methodName - the method name to call

Returns:

a reference to this, so the API can be used fluently

response

Future<GrpcClientResponse<Req,Resp>> response()

Returns:

the gRPC response

exceptionHandler

GrpcClientRequest<Req,Resp> exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface GrpcWriteStream<Req>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<Req>

setWriteQueueMaxSize

GrpcClientRequest<Req,Resp> setWriteQueueMaxSize(int maxSize)

Specified by:

setWriteQueueMaxSize in interface GrpcWriteStream<Req>

Specified by:

setWriteQueueMaxSize in interface WriteStream<Req>

drainHandler

GrpcClientRequest<Req,Resp> drainHandler(Handler<Void> handler)

Specified by:

drainHandler in interface GrpcWriteStream<Req>

Specified by:

drainHandler in interface WriteStream<Req>

idleTimeout

GrpcClientRequest<Req,Resp> idleTimeout(long timeout)

Sets the amount of time after which, if the request does not return any data within the timeout period, the request/response is cancelled and the related futures.

Parameters:

timeout - the amount of time in milliseconds.

Returns:

a reference to this, so the API can be used fluently

connection

io.vertx.core.http.HttpConnection connection()

Returns:

the underlying HTTP connection

send

default Future<GrpcClientResponse<Req,Resp>> send(Req item)

send

default Future<GrpcClientResponse<Req,Resp>> send(ReadStream<Req> body)