io.grpc.internal

Class ApplicationThreadDeframer

java.lang.Object

io.grpc.internal.ApplicationThreadDeframer

All Implemented Interfaces:

Deframer, MessageDeframer.Listener

public class ApplicationThreadDeframer
extends Object
implements Deframer, MessageDeframer.Listener

Sits between AbstractStream.TransportState and MessageDeframer to deframe in the client thread. Calls from the transport to the deframer are wrapped into an InitializingMessageProducer and given back to the transport, where they will be run on the client thread. Calls from the deframer back to the transport use TransportExecutor#runOnTransportThread to run on the transport thread.

Method Summary

Modifier and Type	Method and Description
void	bytesRead(int numBytes) Called when the given number of bytes has been read from the input source of the deframer.
void	close() Closes this deframer and frees any resources.
void	closeWhenComplete() Close when any messages currently queued have been requested and delivered.
void	deframe(ReadableBuffer data) Adds the given data to this deframer and attempts delivery to the listener.
void	deframeFailed(Throwable cause) Called when a MessageDeframer.deframe(ReadableBuffer) operation failed.
void	deframerClosed(boolean hasPartialMessage) Called when the deframer closes.
void	messagesAvailable(StreamListener.MessageProducer producer) Called to deliver the next complete message.
void	request(int numMessages) Requests up to the given number of messages from the call.
void	setDecompressor(Decompressor decompressor) Sets the decompressor available to use.
void	setFullStreamDecompressor(io.grpc.internal.GzipInflatingBuffer fullStreamDecompressor) Sets the decompressor used for full-stream decompression.
void	setMaxInboundMessageSize(int messageSize)

Methods inherited from class java.lang.Object

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

Method Detail

setMaxInboundMessageSize

public void setMaxInboundMessageSize(int messageSize)

Specified by:

setMaxInboundMessageSize in interface Deframer

setDecompressor

public void setDecompressor(Decompressor decompressor)

Description copied from interface: Deframer

Sets the decompressor available to use. The message encoding for the stream comes later in time, and thus will not be available at the time of construction. This should only be set once, since the compression codec cannot change after the headers have been sent.

Specified by:

setDecompressor in interface Deframer

Parameters:

decompressor - the decompressing wrapper.

setFullStreamDecompressor

public void setFullStreamDecompressor(io.grpc.internal.GzipInflatingBuffer fullStreamDecompressor)

Description copied from interface: Deframer

Sets the decompressor used for full-stream decompression. Full-stream decompression disables any per-message decompressor set by Deframer.setDecompressor(io.grpc.Decompressor).

Specified by:

setFullStreamDecompressor in interface Deframer

Parameters:

fullStreamDecompressor - the decompressing wrapper

request

public void request(int numMessages)

Description copied from interface: Deframer

Requests up to the given number of messages from the call. No additional messages will be delivered.

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

Specified by:

request in interface Deframer

Parameters:

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

deframe

public void deframe(ReadableBuffer data)

Description copied from interface: Deframer

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

Specified by:

deframe in interface Deframer

Parameters:

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

closeWhenComplete

public void closeWhenComplete()

Description copied from interface: Deframer

Close when any messages currently queued have been requested and delivered.

Specified by:

closeWhenComplete in interface Deframer

close

public void close()

Description copied from interface: Deframer

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

Specified by:

close in interface Deframer

bytesRead

public void bytesRead(int numBytes)

Description copied from interface: MessageDeframer.Listener

Called when the given number of bytes has been read from the input source of the deframer. This is typically used to indicate to the underlying transport that more data can be accepted.

Specified by:

bytesRead in interface MessageDeframer.Listener

Parameters:

numBytes - the number of bytes read from the deframer's input source.

messagesAvailable

public void messagesAvailable(StreamListener.MessageProducer producer)

Description copied from interface: MessageDeframer.Listener

Called to deliver the next complete message.

Specified by:

messagesAvailable in interface MessageDeframer.Listener

Parameters:

producer - single message producer wrapping the message.

deframerClosed

public void deframerClosed(boolean hasPartialMessage)

Description copied from interface: MessageDeframer.Listener

Called when the deframer closes.

Specified by:

deframerClosed in interface MessageDeframer.Listener

Parameters:

hasPartialMessage - whether the deframer contained an incomplete message at closing.

deframeFailed

public void deframeFailed(Throwable cause)

Description copied from interface: MessageDeframer.Listener

Called when a MessageDeframer.deframe(ReadableBuffer) operation failed.

Specified by:

deframeFailed in interface MessageDeframer.Listener

Parameters:

cause - the actual failure