BidirectionalStream

STREAM_PRIORITY_HIGHEST

public static final int STREAM_PRIORITY_HIGHEST

Highest stream priority. Passed to Builder#setPriority.

Constant Value: 4 (0x00000004)

STREAM_PRIORITY_IDLE

public static final int STREAM_PRIORITY_IDLE

Lowest stream priority. Passed to Builder#setPriority.

Constant Value: 0 (0x00000000)

STREAM_PRIORITY_LOW

public static final int STREAM_PRIORITY_LOW

Low stream priority. Passed to Builder#setPriority.

Constant Value: 2 (0x00000002)

STREAM_PRIORITY_LOWEST

public static final int STREAM_PRIORITY_LOWEST

Very low stream priority. Passed to Builder#setPriority.

Constant Value: 1 (0x00000001)

STREAM_PRIORITY_MEDIUM

public static final int STREAM_PRIORITY_MEDIUM

Medium stream priority. Passed to Builder#setPriority. This is the default priority given to the stream.

Constant Value: 3 (0x00000003)

BidirectionalStream

public BidirectionalStream ()

cancel

public abstract void cancel ()

Cancels the stream. Can be called at any time after start(). onCanceled() will be invoked when cancelation is complete and no further callback methods will be invoked. If the stream has completed or has not started, calling cancel() has no effect and onCanceled() will not be invoked. If the Executor passed in during BidirectionalStream construction runs tasks on a single thread, and cancel() is called on that thread, no listener methods (besides onCanceled()) will be invoked after cancel() is called. Otherwise, at most one callback method may be invoked after cancel() has completed.

flush

public abstract void flush ()

Flushes pending writes. This method should not be invoked before onStreamReady(). For previously delayed write()s, a corresponding onWriteCompleted() will be invoked when the buffer is sent.

getHeaders

public abstract HeaderBlock getHeaders ()

See Builder#addHeader(String, String)

getHttpMethod

public abstract String getHttpMethod ()

See BidirectionalStream.Builder#setHttpMethod(String).

getPriority

public abstract int getPriority ()

See Builder#setPriority(int)

getTrafficStatsTag

public abstract int getTrafficStatsTag ()

See BidirectionalStream.Builder#setTrafficStatsTag(int)

getTrafficStatsUid

public abstract int getTrafficStatsUid ()

See BidirectionalStream.Builder#setTrafficStatsUid(int)

hasTrafficStatsTag

public abstract boolean hasTrafficStatsTag ()

See BidirectionalStream.Builder#setTrafficStatsTag(int)

hasTrafficStatsUid

public abstract boolean hasTrafficStatsUid ()

See BidirectionalStream.Builder#setTrafficStatsUid(int)

isDelayRequestHeadersUntilFirstFlushEnabled

public abstract boolean isDelayRequestHeadersUntilFirstFlushEnabled ()

See Builder#setDelayRequestHeadersUntilFirstFlushEnabled(boolean)

isDone

public abstract boolean isDone ()

Returns true if the stream was successfully started and is now done (succeeded, canceled, or failed).

read

public abstract void read (ByteBuffer buffer)

Reads data from the stream into the provided buffer. Can only be called at most once in response to each invocation of the onStreamReady()/ onResponseHeadersReceived() and onReadCompleted() methods of the Callback. Each call will result in an invocation of one of the Callback's onReadCompleted() method if data is read, or its onFailed() method if there's an error. An attempt to read data into buffer starting at buffer.position() is begun. At most buffer.remaining() bytes are read. buffer.position() is updated upon invocation of onReadCompleted() to indicate how much data was read.

start

public abstract void start ()

Starts the stream, all callbacks go to the callback argument passed to BidirectionalStream.Builder's constructor. Should only be called once.

write

public abstract void write (ByteBuffer buffer, 
                boolean endOfStream)

Attempts to write data from the provided buffer into the stream. If auto flush is disabled, data will be sent only after flush() is called. Each call will result in an invocation of one of the Callback's onWriteCompleted() method if data is sent, or its onFailed() method if there's an error. An attempt to write data from buffer starting at buffer.position() is begun. buffer.remaining() bytes will be written. onWriteCompleted() will be invoked only when the full ByteBuffer is written.