io.grpc.transport

Class MessageDeframer

java.lang.Object

io.grpc.transport.MessageDeframer

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class MessageDeframer
extends Object
implements Closeable

Deframer for GRPC frames.

This class is not thread-safe. All calls to public methods should be made in the transport thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageDeframer.Compression
static interface	MessageDeframer.Listener A listener of deframing events.

Constructor Summary

Constructors

Constructor and Description
MessageDeframer(MessageDeframer.Listener listener) Creates a deframer.
MessageDeframer(MessageDeframer.Listener listener, MessageDeframer.Compression compression) Create a deframer.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this deframer and frees any resources.
void	deframe(ReadableBuffer data, boolean endOfStream) Adds the given data to this deframer and attempts delivery to the sink.
boolean	isClosed() Indicates whether or not this deframer has been closed.
boolean	isStalled() Indicates whether delivery is currently stalled, pending receipt of more data.
void	request(int numMessages) Requests up to the given number of messages from the call to be delivered to MessageDeframer.Listener.messageRead(InputStream).

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageDeframer

public MessageDeframer(MessageDeframer.Listener listener)

Creates a deframer. Compression will not be supported.

Parameters:

listener - listener for deframer events.

MessageDeframer

public MessageDeframer(MessageDeframer.Listener listener,
                       MessageDeframer.Compression compression)

Create a deframer.

Parameters:

listener - listener for deframer events.

compression - the compression used if a compressed frame is encountered, with NONE meaning unsupported

Method Detail

request

public void request(int numMessages)

Requests up to the given number of messages from the call to be delivered to MessageDeframer.Listener.messageRead(InputStream). No additional messages will be delivered.

If close() has been called, this method will have no effect.

Parameters:

numMessages - the requested number of messages to be delivered to the listener.

deframe

public void deframe(ReadableBuffer data,
                    boolean endOfStream)

Adds the given data to this deframer and attempts delivery to the sink.

Parameters:

data - the raw data read from the remote endpoint. Must be non-null.

endOfStream - if true, indicates that data is the end of the stream from the remote endpoint.

Throws:

IllegalStateException - if close() has been called previously or if deframe(ReadableBuffer, boolean) has previously been called with endOfStream=true.

isStalled

public boolean isStalled()

Indicates whether delivery is currently stalled, pending receipt of more data.

close

public void close()

Closes this deframer and frees any resources. After this method is called, additional calls will have no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Indicates whether or not this deframer has been closed.