io.grpc.transport

Class MessageFramer

java.lang.Object

io.grpc.transport.MessageFramer

public class MessageFramer
extends Object

Encodes gRPC messages to be delivered via the transport layer which implements MessageFramer.Sink.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageFramer.Compression
static interface	MessageFramer.Sink Sink implemented by the transport layer to receive frames and forward them to their destination.

Constructor Summary

Constructors

Constructor and Description
MessageFramer(MessageFramer.Sink sink, WritableBufferAllocator bufferAllocator) Creates a MessageFramer without compression.
MessageFramer(MessageFramer.Sink sink, WritableBufferAllocator bufferAllocator, MessageFramer.Compression compression) Creates a MessageFramer.

Method Summary

Modifier and Type	Method and Description
void	close() Flushes and closes the framer and releases any buffers.
void	dispose() Closes the framer and releases any buffers, but does not flush.
void	flush() Flushes any buffered data in the framer to the sink.
boolean	isClosed() Indicates whether or not this framer has been closed via a call to either close() or dispose().
void	writePayload(InputStream message, int messageLength) Writes out a payload message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageFramer

public MessageFramer(MessageFramer.Sink sink,
                     WritableBufferAllocator bufferAllocator)

Creates a MessageFramer without compression.

Parameters:

sink - the sink used to deliver frames to the transport

bufferAllocator - allocates buffers that the transport can commit to the wire.

MessageFramer

public MessageFramer(MessageFramer.Sink sink,
                     WritableBufferAllocator bufferAllocator,
                     MessageFramer.Compression compression)

Creates a MessageFramer.

Parameters:

sink - the sink used to deliver frames to the transport

bufferAllocator - allocates buffers that the transport can commit to the wire.

compression - the compression type

Method Detail

writePayload

public void writePayload(InputStream message,
                         int messageLength)

Writes out a payload message.

Parameters:

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

messageLength - the number of bytes in the message. It must match the actual number of bytes in the InputStream.

flush

public void flush()

Flushes any buffered data in the framer to the sink.

isClosed

public boolean isClosed()

Indicates whether or not this framer has been closed via a call to either close() or dispose().

close

public void close()

Flushes and closes the framer and releases any buffers. After the framer is closed or disposed, additional calls to this method will have no affect.

dispose

public void dispose()

Closes the framer and releases any buffers, but does not flush. After the framer is closed or disposed, additional calls to this method will have no affect.