Package io.grpc.internal

Class ClientCallImpl.ClientStreamListenerImpl

java.lang.Object

io.grpc.internal.ClientCallImpl.ClientStreamListenerImpl

All Implemented Interfaces:

ClientStreamListener, StreamListener

Enclosing class:

ClientCallImpl<ReqT,RespT>

private class ClientCallImpl.ClientStreamListenerImpl
extends java.lang.Object
implements ClientStreamListener

Nested Class Summary

Nested classes/interfaces inherited from interface io.grpc.internal.ClientStreamListener

ClientStreamListener.RpcProgress

Nested classes/interfaces inherited from interface io.grpc.internal.StreamListener

StreamListener.MessageProducer

Field Summary

Fields

Modifier and Type	Field	Description
private Status	exceptionStatus
private ClientCall.Listener<RespT>	observer

Constructor Summary

Constructors

Constructor	Description
ClientStreamListenerImpl(ClientCall.Listener<RespT> observer)

Method Summary

Modifier and Type	Method	Description
void	closed(Status status, ClientStreamListener.RpcProgress rpcProgress, Metadata trailers)	Called when the stream is fully closed.
private void	closedInternal(Status status, ClientStreamListener.RpcProgress rpcProgress, Metadata trailers)
private void	exceptionThrown(Status status)	Cancels call and schedules onClose() notification.
void	headersRead(Metadata headers)	Called upon receiving all header information from the remote end-point.
void	messagesAvailable(StreamListener.MessageProducer producer)	Called upon receiving a message from the remote end-point.
void	onReady()	This indicates that the transport is now capable of sending additional messages without requiring excessive buffering internally.

Methods inherited from class java.lang.Object

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

Field Detail

observer

private final ClientCall.Listener<RespT> observer

exceptionStatus

private Status exceptionStatus

Constructor Detail

ClientStreamListenerImpl

public ClientStreamListenerImpl(ClientCall.Listener<RespT> observer)

Method Detail

exceptionThrown

private void exceptionThrown(Status status)

Cancels call and schedules onClose() notification. May only be called from the application thread.

headersRead

public void headersRead(Metadata headers)

Description copied from interface: ClientStreamListener

Called upon receiving all header information from the remote end-point. Note that transports are not required to call this method if no header information is received, this would occur when a stream immediately terminates with an error and only ClientStreamListener.closed(io.grpc.Status, RpcProgress, Metadata) is called.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

headersRead in interface ClientStreamListener

Parameters:

headers - the fully buffered received headers.

messagesAvailable

public void messagesAvailable(StreamListener.MessageProducer producer)

Description copied from interface: StreamListener

Called upon receiving a message from the remote end-point.

Implementations must eventually drain the provided producer StreamListener.MessageProducer completely by invoking StreamListener.MessageProducer.next() to obtain deframed messages until the producer returns null.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

messagesAvailable in interface StreamListener

Parameters:

producer - supplier of deframed messages.

closed

public void closed(Status status,
                   ClientStreamListener.RpcProgress rpcProgress,
                   Metadata trailers)

Description copied from interface: ClientStreamListener

Called when the stream is fully closed. Status.Code.OK is the only status code that is guaranteed to have been sent from the remote server. Any other status code may have been caused by abnormal stream termination. This is guaranteed to always be the final call on a listener. No further callbacks will be issued.

This method should return quickly, as the same thread may be used to process other streams.

Specified by:

closed in interface ClientStreamListener

Parameters:

status - details about the remote closure

rpcProgress - RPC progress when client stream listener is closed

trailers - trailing metadata

closedInternal

private void closedInternal(Status status,
                            ClientStreamListener.RpcProgress rpcProgress,
                            Metadata trailers)

onReady

public void onReady()

Description copied from interface: StreamListener

This indicates that the transport is now capable of sending additional messages without requiring excessive buffering internally. This event is just a suggestion and the application is free to ignore it, however doing so may result in excessive buffering within the transport.

Specified by:

onReady in interface StreamListener