io.grpc.internal

Interface Stream

All Known Subinterfaces:

ClientStream, ServerStream

All Known Implementing Classes:

AbstractClientStream, AbstractServerStream, AbstractStream, Http2ClientStream

public interface Stream

A single stream of communication between two end-points within a transport.

An implementation doesn't need to be thread-safe. All methods are expected to execute quickly.

Method Summary

Modifier and Type	Method and Description
void	flush() Flushes any internally buffered messages to the remote end-point.
boolean	isReady() If true, indicates that the transport is capable of sending additional messages without requiring excessive buffering internally.
void	request(int numMessages) Requests up to the given number of messages from the call to be delivered to StreamListener.messageRead(java.io.InputStream).
void	writeMessage(InputStream message) Writes a message payload to the remote end-point.

Method Detail

request

void request(int numMessages)

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

Parameters:

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

writeMessage

void writeMessage(InputStream message)

Writes a message payload to the remote end-point. The bytes from the stream are immediately read by the Transport. Where possible callers should use streams that are KnownLength to improve efficiency. This method will always return immediately and will not wait for the write to complete.

When the write is "accepted" by the transport, the given callback (if provided) will be called. The definition of what it means to be "accepted" is up to the transport implementation, but this is a general indication that the transport is capable of handling more out-bound data on the stream. If the stream/connection is closed for any reason before the write could be accepted, the callback will never be invoked.

Parameters:

message - stream containing the serialized message to be sent

flush

void flush()

Flushes any internally buffered messages to the remote end-point.

isReady

boolean isReady()

If true, indicates that the transport is 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.