Interface StreamController (2.47.0)

Version 2.47.0

• 2.58.0 (latest)
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

public interface StreamController

Allows the implementer of ResponseObserver to control the flow of responses.

An instance of this class will be passed to ResponseObserver#onStart(StreamController), at which point the receiver can disable automatic flow control. The receiver can also save a reference to the instance and terminate the stream early using cancel().

Methods

cancel()

public abstract void cancel()

Cancel the stream early.

This will manifest as an onError on the ResponseObserver with the cause being a CancellationException.

disableAutoInboundFlowControl()

public abstract void disableAutoInboundFlowControl()

Disables automatic flow control.

The next response is requested immediately after the current response is processed by ResponseObserver#onResponse(Object). If disabled, an application must make explicit calls to #request to receive messages.

request(int count)

public abstract void request(int count)

Requests up to the given number of responses from the call to be delivered to ResponseObserver#onResponse(Object). No additional messages will be delivered.

This method can only be called after disabling automatic flow control.

Message delivery is guaranteed to be sequential in the order received. In addition, the listener methods will not be accessed concurrently. While it is not guaranteed that the same thread will always be used, it is guaranteed that only a single thread will access the listener at a time.

If called multiple times, the number of messages able to delivered will be the sum of the calls.

This method is safe to call from multiple threads without external synchronizaton.

Parameter
Name	Description
count	int the requested number of messages to be delivered to the listener. Must be non-negative.