io.vertx.grpc.common

Interface GrpcWriteStream<T>

All Superinterfaces:

StreamBase, WriteStream<T>

public interface GrpcWriteStream<T>
extends WriteStream<T>

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the stream.
GrpcWriteStream<T>	drainHandler(Handler<Void> handler)
GrpcWriteStream<T>	encoding(String encoding) Set the stream encoding, e.g identity or gzip.
Future<Void>	endMessage(GrpcMessage message) End the stream with an encoded gRPC message.
GrpcWriteStream<T>	exceptionHandler(Handler<Throwable> handler)
MultiMap	headers()
GrpcWriteStream<T>	setWriteQueueMaxSize(int i)
Future<Void>	writeMessage(GrpcMessage message) Write an encoded gRPC message.

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

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

Method Detail

headers

MultiMap headers()

Returns:

the MultiMap to reader metadata headers

encoding

GrpcWriteStream<T> encoding(String encoding)

Set the stream encoding, e.g identity or gzip. It must be called before sending any message, otherwise {@code identity will be used.

Parameters:

encoding - the target message encoding

Returns:

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

exceptionHandler

GrpcWriteStream<T> exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<T>

setWriteQueueMaxSize

GrpcWriteStream<T> setWriteQueueMaxSize(int i)

Specified by:

setWriteQueueMaxSize in interface WriteStream<T>

drainHandler

GrpcWriteStream<T> drainHandler(Handler<Void> handler)

Specified by:

drainHandler in interface WriteStream<T>

writeMessage

Future<Void> writeMessage(GrpcMessage message)

Write an encoded gRPC message.

Parameters:

message - the message

Returns:

a future completed with the result

endMessage

Future<Void> endMessage(GrpcMessage message)

End the stream with an encoded gRPC message.

Parameters:

message - the message

Returns:

a future completed with the result

cancel

void cancel()

Cancel the stream.