Package io.grpc.internal
Class ForwardingClientStreamListener
- java.lang.Object
-
- io.grpc.internal.ForwardingClientStreamListener
-
- All Implemented Interfaces:
ClientStreamListener
,StreamListener
abstract class ForwardingClientStreamListener 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
-
-
Constructor Summary
Constructors Constructor Description ForwardingClientStreamListener()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
closed(Status status, ClientStreamListener.RpcProgress rpcProgress, Metadata trailers)
Called when the stream is fully closed.protected abstract ClientStreamListener
delegate()
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.java.lang.String
toString()
-
-
-
Method Detail
-
delegate
protected abstract ClientStreamListener delegate()
-
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 onlyClientStreamListener.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 interfaceClientStreamListener
- Parameters:
headers
- the fully buffered received headers.
-
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 interfaceClientStreamListener
- Parameters:
status
- details about the remote closurerpcProgress
- RPC progress when client stream listener is closedtrailers
- trailing metadata
-
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 invokingStreamListener.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 interfaceStreamListener
- Parameters:
producer
- supplier of deframed messages.
-
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 interfaceStreamListener
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-