io.vertx.grpc.server

Interface GrpcServerResponse<Req,Resp>

All Superinterfaces:

GrpcWriteStream<Resp>, StreamBase, WriteStream<Resp>

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

Method Summary

Modifier and Type	Method and Description
Set<String>	acceptedEncodings()
GrpcServerResponse<Req,Resp>	drainHandler(Handler<Void> handler)
GrpcServerResponse<Req,Resp>	encoding(String encoding)
GrpcServerResponse<Req,Resp>	exceptionHandler(Handler<Throwable> handler)
default Future<Void>	send(ReadStream<Resp> body)
default Future<Void>	send(Resp item)
GrpcServerResponse<Req,Resp>	setWriteQueueMaxSize(int maxSize)
GrpcServerResponse<Req,Resp>	status(GrpcStatus status) Set the grpc status response
GrpcServerResponse<Req,Resp>	statusMessage(String msg) Set the grpc status response message
MultiMap	trailers()
Future<Void>	writeHead() Send the response headers.

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

status

GrpcServerResponse<Req,Resp> status(GrpcStatus status)

Set the grpc status response

Parameters:

status - the status

Returns:

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

statusMessage

GrpcServerResponse<Req,Resp> statusMessage(String msg)

Set the grpc status response message

Parameters:

msg - the message

Returns:

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

encoding

GrpcServerResponse<Req,Resp> encoding(String encoding)

Specified by:

encoding in interface GrpcWriteStream<Resp>

acceptedEncodings

Set<String> acceptedEncodings()

Returns:

the set of accepted encodings sent by the client, note that identity should not be part of this set. This can be used to set the response encoding to ensure the client will accept the encoding. This is a glorified wrapper for the grpc-accept-encoding header.

trailers

MultiMap trailers()

Returns:

the MultiMap to write metadata trailers

exceptionHandler

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

Specified by:

exceptionHandler in interface GrpcWriteStream<Resp>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<Resp>

setWriteQueueMaxSize

GrpcServerResponse<Req,Resp> setWriteQueueMaxSize(int maxSize)

Specified by:

setWriteQueueMaxSize in interface GrpcWriteStream<Resp>

Specified by:

setWriteQueueMaxSize in interface WriteStream<Resp>

drainHandler

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

Specified by:

drainHandler in interface GrpcWriteStream<Resp>

Specified by:

drainHandler in interface WriteStream<Resp>

writeHead

Future<Void> writeHead()

Send the response headers.

Returns:

a future notified by the success or failure of the write

send

default Future<Void> send(Resp item)

send

default Future<Void> send(ReadStream<Resp> body)