AbstractStream (grpc-all 0.8.0 API)

java.lang.Object
- io.grpc.internal.AbstractStream<IdT>

Type Parameters:

IdT - type of the unique identifier of this stream.

All Implemented Interfaces:

Stream

Direct Known Subclasses:

AbstractClientStream, AbstractServerStream
```
public abstract class AbstractStream<IdT>
extends Object
implements Stream
```
Abstract base class for Stream implementations.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractStream.Phase
Indicates the phase of the GRPC stream in one direction.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractStream.Phase` Indicates the phase of the GRPC stream in one direction.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ONREADY_THRESHOLD` The default number of queued bytes for a given stream, below which `StreamListener.onReady()` will be called.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReceive()` Returns `true` if the stream can receive data from its remote peer.
`boolean`	`canSend()` Returns `true` if the stream can send data to its remote peer.
`protected void`	`closeDeframer()` Closes this deframer and frees any resources.
`protected void`	`deframe(ReadableBuffer frame, boolean endOfStream)` Called to parse a received frame and attempt delivery of any completed messages.
`protected abstract void`	`deframeFailed(Throwable cause)` Called when a `deframe(ReadableBuffer, boolean)` operation failed.
`void`	`dispose()` Frees any resources associated with this stream.
`void`	`flush()` Flushes any internally buffered messages to the remote end-point.
`int`	`getOnReadyThreshold()` The number of queued bytes for a given stream, below which `StreamListener.onReady()` will be called.
`abstract IdT`	`id()` Returns the internal ID for this stream.
`protected abstract void`	`inboundDeliveryPaused()` Handles the event that the deframer has no pending deliveries.
`protected abstract void`	`internalSendFrame(WritableBuffer frame, boolean endOfStream, boolean flush)` Sends an outbound frame to the remote end point.
`boolean`	`isClosed()` Whether the stream is fully closed.
`protected boolean`	`isDeframerStalled()` Indicates whether delivery is currently stalled, pending receipt of more data.
`boolean`	`isReady()` If `true`, indicates that the transport is capable of sending additional messages without requiring excessive buffering internally.
`protected abstract StreamListener`	`listener()` Override this method to provide a stream listener.
`protected void`	`onSendingBytes(int numBytes)` Event handler to be called by the subclass when a number of bytes are being queued for sending to the remote endpoint.
`protected void`	`onSentBytes(int numBytes)` Event handler to be called by the subclass when a number of bytes has been sent to the remote endpoint.
`protected void`	`onStreamAllocated()` Event handler to be called by the subclass when the stream's headers have passed any connection flow control (i.e., MAX_CONCURRENT_STREAMS).
`protected abstract void`	`receiveMessage(InputStream is)` Handles a message that was just deframed.
`protected abstract void`	`remoteEndClosed()` Handles the event that the deframer has reached end of stream.
`protected void`	`requestMessagesFromDeframer(int numMessages)` Called to request the given number of messages from the deframer.
`protected abstract void`	`returnProcessedBytes(int processedBytes)` Returns the given number of processed bytes back to inbound flow control to enable receipt of more data.
`String`	`toString()`
`protected Objects.ToStringHelper`	`toStringHelper()`
`void`	`writeMessage(InputStream message)` Writes a message payload to the remote end-point.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.grpc.internal.Stream
request

- Field Detail
  - DEFAULT_ONREADY_THRESHOLD
```
public static final int DEFAULT_ONREADY_THRESHOLD
```
    The default number of queued bytes for a given stream, below which StreamListener.onReady() will be called.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - listener
```
protected abstract StreamListener listener()
```
    Override this method to provide a stream listener.
  - id
```
@Nullable
public abstract IdT id()
```
    Returns the internal ID for this stream. Note that ID can be null for client streams as the transport may defer creating the stream to the remote side until it has a payload or metadata to send.
  - getOnReadyThreshold
```
public int getOnReadyThreshold()
```
    The number of queued bytes for a given stream, below which StreamListener.onReady() will be called. Defaults to DEFAULT_ONREADY_THRESHOLD.
  - writeMessage
```
public void writeMessage(InputStream message)
```
    Description copied from interface: Stream
    
    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.
    
    Specified by:
    
    writeMessage in interface Stream
    
    Parameters:
    
    message - stream containing the serialized message to be sent
  - flush
```
public final void flush()
```
    Description copied from interface: Stream
    
    Flushes any internally buffered messages to the remote end-point.
    
    Specified by:
    
    flush in interface Stream
  - isReady
```
public final boolean isReady()
```
    Description copied from interface: Stream
    
    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.
    
    Specified by:
    
    isReady in interface Stream
  - dispose
```
public void dispose()
```
    Frees any resources associated with this stream. Subclass implementations must call this version.
    NOTE: Can be called by both the transport thread and the application thread. Transport threads need to dispose when the remote side has terminated the stream. Application threads will dispose when the application decides to close the stream as part of normal processing.
  - internalSendFrame
```
protected abstract void internalSendFrame(WritableBuffer frame,
                                          boolean endOfStream,
                                          boolean flush)
```
    Sends an outbound frame to the remote end point.
    
    Parameters:
    
    frame - a buffer containing the chunk of data to be sent.
    
    endOfStream - if true indicates that no more data will be sent on the stream by this endpoint.
    
    flush - true if more data may not be arriving soon
  - receiveMessage
```
protected abstract void receiveMessage(InputStream is)
```
    Handles a message that was just deframed.
    
    Parameters:
    
    is - the stream containing the message
  - inboundDeliveryPaused
```
protected abstract void inboundDeliveryPaused()
```
    Handles the event that the deframer has no pending deliveries.
  - remoteEndClosed
```
protected abstract void remoteEndClosed()
```
    Handles the event that the deframer has reached end of stream.
  - returnProcessedBytes
```
protected abstract void returnProcessedBytes(int processedBytes)
```
    Returns the given number of processed bytes back to inbound flow control to enable receipt of more data.
  - deframeFailed
```
protected abstract void deframeFailed(Throwable cause)
```
    Called when a deframe(ReadableBuffer, boolean) operation failed.
    
    Parameters:
    
    cause - the actual failure
  - closeDeframer
```
protected final void closeDeframer()
```
    Closes this deframer and frees any resources. After this method is called, additional calls will have no effect.
  - deframe
```
protected final void deframe(ReadableBuffer frame,
                             boolean endOfStream)
```
    Called to parse a received frame and attempt delivery of any completed messages. Must be called from the transport thread.
  - isDeframerStalled
```
protected final boolean isDeframerStalled()
```
    Indicates whether delivery is currently stalled, pending receipt of more data.
  - requestMessagesFromDeframer
```
protected final void requestMessagesFromDeframer(int numMessages)
```
    Called to request the given number of messages from the deframer. Must be called from the transport thread.
  - onStreamAllocated
```
protected final void onStreamAllocated()
```
    Event handler to be called by the subclass when the stream's headers have passed any connection flow control (i.e., MAX_CONCURRENT_STREAMS). It may call the listener's StreamListener.onReady() handler if appropriate. This must be called from the transport thread, since the listener may be called back directly.
  - onSendingBytes
```
protected final void onSendingBytes(int numBytes)
```
    Event handler to be called by the subclass when a number of bytes are being queued for sending to the remote endpoint.
    
    Parameters:
    
    numBytes - the number of bytes being sent.
  - onSentBytes
```
protected final void onSentBytes(int numBytes)
```
    Event handler to be called by the subclass when a number of bytes has been sent to the remote endpoint. May call back the listener's StreamListener.onReady() handler if appropriate. This must be called from the transport thread, since the listener may be called back directly.
    
    Parameters:
    
    numBytes - the number of bytes that were sent.
  - canReceive
```
public boolean canReceive()
```
    Returns true if the stream can receive data from its remote peer.
  - canSend
```
public boolean canSend()
```
    Returns true if the stream can send data to its remote peer.
  - isClosed
```
public boolean isClosed()
```
    Whether the stream is fully closed. Note that this method is not thread-safe as inboundPhase and outboundPhase are mutated in different threads. Tests must account for thread coordination when calling.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringHelper
```
protected Objects.ToStringHelper toStringHelper()
```

Class AbstractStream<IdT>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.grpc.internal.Stream

Field Detail

DEFAULT_ONREADY_THRESHOLD

Method Detail

listener

id

getOnReadyThreshold

writeMessage

flush

isReady

dispose

internalSendFrame

receiveMessage

inboundDeliveryPaused

remoteEndClosed

returnProcessedBytes

deframeFailed

closeDeframer

deframe

isDeframerStalled

requestMessagesFromDeframer

onStreamAllocated

onSendingBytes

onSentBytes

canReceive

canSend

isClosed

toString

toStringHelper