Package io.vertx.reactivex.grpc.client
Class GrpcClientRequest<Req,Resp>
- java.lang.Object
-
- io.vertx.reactivex.grpc.common.GrpcWriteStream<Req>
-
- io.vertx.reactivex.grpc.client.GrpcClientRequest<Req,Resp>
-
- All Implemented Interfaces:
StreamBase
,WriteStream<Req>
public class 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 servicefullMethodName(java.lang.String)
.Writing a request message will send the request to the service:
- To send a unary request, just call
- To send a streaming request, call any time you need and then
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
original
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<GrpcClientRequest>
__TYPE_ARG
TypeArg<Req>
__typeArg_0
TypeArg<Resp>
__typeArg_1
-
Constructor Summary
Constructors Constructor Description GrpcClientRequest(GrpcClientRequest delegate)
GrpcClientRequest(Object delegate, TypeArg<Req> typeArg_0, TypeArg<Resp> typeArg_1)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpConnection
connection()
GrpcClientRequest<Req,Resp>
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.GrpcClientRequest<Req,Resp>
encoding(String encoding)
Set the stream encoding, e.gidentity
orgzip
.void
end()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(Handler<AsyncResult<Void>> handler)
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(Req data)
Same as but with anhandler
called when the operation completesvoid
end(Req data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesboolean
equals(Object o)
GrpcClientRequest<Req,Resp>
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.GrpcClientRequest<Req,Resp>
fullMethodName(String fullMethodName)
Set the full method name to call, it must follow the formatpackage-name + '.' + service-name + '/' + method-name
or anIllegalArgumentException
is thrown.GrpcClientRequest
getDelegate()
int
hashCode()
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.static <Req,Resp>
GrpcClientRequest<Req,Resp>newInstance(GrpcClientRequest arg)
static <Req,Resp>
GrpcClientRequest<Req,Resp>newInstance(GrpcClientRequest arg, TypeArg<Req> __typeArg_Req, TypeArg<Resp> __typeArg_Resp)
Future<GrpcClientResponse<Req,Resp>>
response()
io.reactivex.Completable
rxEnd()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxEnd(Req data)
Same as but with anhandler
called when the operation completesio.reactivex.Single<GrpcClientResponse<Req,Resp>>
rxResponse()
io.reactivex.Single<GrpcClientResponse<Req,Resp>>
rxSend(io.reactivex.Flowable<Req> body)
io.reactivex.Single<GrpcClientResponse<Req,Resp>>
rxSend(ReadStream<Req> body)
io.reactivex.Single<GrpcClientResponse<Req,Resp>>
rxSend(Req item)
io.reactivex.Completable
rxWrite(Req data)
Same as but with anhandler
called when the operation completesFuture<GrpcClientResponse<Req,Resp>>
send(io.reactivex.Flowable<Req> body)
Future<GrpcClientResponse<Req,Resp>>
send(ReadStream<Req> body)
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)
Set the maximum size of the write queue tomaxSize
.WriteStreamObserver<Req>
toObserver()
String
toString()
WriteStreamSubscriber<Req>
toSubscriber()
void
write(Req data)
Same as but with anhandler
called when the operation completesvoid
write(Req data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesboolean
writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
Methods inherited from class io.vertx.reactivex.grpc.common.GrpcWriteStream
cancel, endMessage, headers, newInstance, newInstance, rxEndMessage, rxWriteMessage, writeMessage
-
-
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toString
in classGrpcWriteStream<Req>
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classGrpcWriteStream<Req>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classGrpcWriteStream<Req>
-
getDelegate
public GrpcClientRequest getDelegate()
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<Req>
- Overrides:
getDelegate
in classGrpcWriteStream<Req>
-
toObserver
public WriteStreamObserver<Req> toObserver()
- Overrides:
toObserver
in classGrpcWriteStream<Req>
-
toSubscriber
public WriteStreamSubscriber<Req> toSubscriber()
- Overrides:
toSubscriber
in classGrpcWriteStream<Req>
-
write
public void write(Req data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<Req>
- Overrides:
write
in classGrpcWriteStream<Req>
- Parameters:
data
-handler
-
-
write
public void write(Req data)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<Req>
- Overrides:
write
in classGrpcWriteStream<Req>
- Parameters:
data
-
-
rxWrite
public io.reactivex.Completable rxWrite(Req data)
Same as but with anhandler
called when the operation completes- Specified by:
rxWrite
in interfaceWriteStream<Req>
- Overrides:
rxWrite
in classGrpcWriteStream<Req>
- Parameters:
data
-- Returns:
-
end
public void end(Handler<AsyncResult<Void>> handler)
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in classGrpcWriteStream<Req>
- Parameters:
handler
-
-
end
public void end()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in classGrpcWriteStream<Req>
-
rxEnd
public io.reactivex.Completable rxEnd()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWriteStream<Req>
- Overrides:
rxEnd
in classGrpcWriteStream<Req>
- Returns:
-
end
public void end(Req data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in classGrpcWriteStream<Req>
- Parameters:
data
-handler
-
-
end
public void end(Req data)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in classGrpcWriteStream<Req>
- Parameters:
data
-
-
rxEnd
public io.reactivex.Completable rxEnd(Req data)
Same as but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWriteStream<Req>
- Overrides:
rxEnd
in classGrpcWriteStream<Req>
- Parameters:
data
-- Returns:
-
writeQueueFull
public boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWriteStream<Req>
- Overrides:
writeQueueFull
in classGrpcWriteStream<Req>
- Returns:
true
if write queue is full
-
encoding
public GrpcClientRequest<Req,Resp> encoding(String encoding)
Description copied from class:GrpcWriteStream
Set the stream encoding, e.gidentity
orgzip
. It must be called before sending any message, otherwise {@code identity will be used.- Overrides:
encoding
in classGrpcWriteStream<Req>
- Parameters:
encoding
- the target message encoding- Returns:
- a reference to this, so the API can be used fluently
-
fullMethodName
public GrpcClientRequest<Req,Resp> fullMethodName(String fullMethodName)
Set the full method name to call, it must follow the formatpackage-name + '.' + service-name + '/' + method-name
or anIllegalArgumentException
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
public 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
public 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
public Future<GrpcClientResponse<Req,Resp>> response()
- Returns:
- the gRPC response
-
rxResponse
public io.reactivex.Single<GrpcClientResponse<Req,Resp>> rxResponse()
- Returns:
- the gRPC response
-
exceptionHandler
public GrpcClientRequest<Req,Resp> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:WriteStream
Set an exception handler on the write stream.- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in interfaceWriteStream<Req>
- Overrides:
exceptionHandler
in classGrpcWriteStream<Req>
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public GrpcClientRequest<Req,Resp> setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStream
Set the maximum size of the write queue tomaxSize
. You will still be able to write to the stream even if there is more thanmaxSize
items in the write queue. This is used as an indicator by classes such asPipe
to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket
, etc...- Specified by:
setWriteQueueMaxSize
in interfaceWriteStream<Req>
- Overrides:
setWriteQueueMaxSize
in classGrpcWriteStream<Req>
- Parameters:
maxSize
- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public GrpcClientRequest<Req,Resp> drainHandler(Handler<Void> handler)
Description copied from interface:WriteStream
Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. SeePipe
for an example of this being used.The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to
maxSize / 2
.- Specified by:
drainHandler
in interfaceWriteStream<Req>
- Overrides:
drainHandler
in classGrpcWriteStream<Req>
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
idleTimeout
public 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
public HttpConnection connection()
- Returns:
- the underlying HTTP connection
-
send
public Future<GrpcClientResponse<Req,Resp>> send(Req item)
-
rxSend
public io.reactivex.Single<GrpcClientResponse<Req,Resp>> rxSend(Req item)
-
send
public Future<GrpcClientResponse<Req,Resp>> send(ReadStream<Req> body)
-
rxSend
public io.reactivex.Single<GrpcClientResponse<Req,Resp>> rxSend(ReadStream<Req> body)
-
send
public Future<GrpcClientResponse<Req,Resp>> send(io.reactivex.Flowable<Req> body)
-
rxSend
public io.reactivex.Single<GrpcClientResponse<Req,Resp>> rxSend(io.reactivex.Flowable<Req> body)
-
newInstance
public static <Req,Resp> GrpcClientRequest<Req,Resp> newInstance(GrpcClientRequest arg)
-
newInstance
public static <Req,Resp> GrpcClientRequest<Req,Resp> newInstance(GrpcClientRequest arg, TypeArg<Req> __typeArg_Req, TypeArg<Resp> __typeArg_Resp)
-
-