io.grpc.internal

Interface Framer

All Known Implementing Classes:

MessageFramer

public interface Framer

Interface for framing gRPC messages.

Method Summary

Modifier and Type	Method and Description
void	close() Closes, with flush.
void	dispose() Closes, without flush.
void	flush() Flush the buffered payload.
boolean	isClosed() Returns whether the framer is closed.
Framer	setCompressor(io.grpc.Compressor compressor) Set the compressor used for compression.
void	setMaxOutboundMessageSize(int maxSize) Set a size limit for each outbound message.
Framer	setMessageCompression(boolean enable) Enable or disable compression.
void	writePayload(InputStream message) Writes out a payload message.

Method Detail

writePayload

void writePayload(InputStream message)

Writes out a payload message.

Parameters:

message - contains the message to be written out. It will be completely consumed.

flush

void flush()

Flush the buffered payload.

isClosed

boolean isClosed()

Returns whether the framer is closed.

close

void close()

Closes, with flush.

dispose

void dispose()

Closes, without flush.

setMessageCompression

Framer setMessageCompression(boolean enable)

Enable or disable compression.

setCompressor

Framer setCompressor(io.grpc.Compressor compressor)

Set the compressor used for compression.

setMaxOutboundMessageSize

void setMaxOutboundMessageSize(int maxSize)

Set a size limit for each outbound message.