# BidirectionalStream.Callback


```
abstract class BidirectionalStream.Callback
```

<br />

*** ** * ** ***

Callback class used to receive callbacks from a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#Callback()()` |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onCanceled(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo)(stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!)` Invoked if the stream was canceled via `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#cancel()`. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onFailed(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo,org.chromium.net.CronetException)( stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!, error: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException! )` Invoked if the stream failed for any reason after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#start()`. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onReadCompleted(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo,java.nio.ByteBuffer,boolean)( stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!, buffer: https://developer.android.com/reference/java/nio/ByteBuffer.html!, endOfStream: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html )` Invoked when data is read into the buffer passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)`. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onResponseHeadersReceived(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo)( stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo! )` Invoked when initial response headers are received. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onResponseTrailersReceived(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo,org.chromium.net.UrlResponseInfo.HeaderBlock)( stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!, trailers: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo.HeaderBlock! )` Invoked when trailers are received before closing the stream. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onStreamReady(org.chromium.net.BidirectionalStream)(stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!)` Invoked when the stream is ready for reading and writing. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onSucceeded(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo)(stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!)` Invoked when there is no data to be read or written and the stream is closed successfully remotely and locally. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback#onWriteCompleted(org.chromium.net.BidirectionalStream,org.chromium.net.UrlResponseInfo,java.nio.ByteBuffer,boolean)( stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!, info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!, buffer: https://developer.android.com/reference/java/nio/ByteBuffer.html!, endOfStream: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html )` Invoked when the entire ByteBuffer passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)` is sent. |

## Public constructors

### Callback

```
Callback()
```

## Public functions

### onCanceled

```
fun onCanceled(stream: BidirectionalStream!, info: UrlResponseInfo!): Unit
```

Invoked if the stream was canceled via `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#cancel()`. Once invoked, no further `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback` methods will be invoked. Default implementation takes no action.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream that was canceled |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information. May be `null` if no response was received. |

### onFailed

```
abstract fun onFailed(
    stream: BidirectionalStream!,
    info: UrlResponseInfo!,
    error: CronetException!
): Unit
```

Invoked if the stream failed for any reason after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#start()`. [HTTP/2 error codes](https://tools.ietf.org/html/rfc7540#section-7) are mapped to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkException#getCronetInternalErrorCode()` codes. Once invoked, no further `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback` methods will be invoked.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream which has failed |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information. May be `null` if no response was received. |
| `error: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException!` | information about the failure |

### onReadCompleted

```
abstract fun onReadCompleted(
    stream: BidirectionalStream!,
    info: UrlResponseInfo!,
    buffer: ByteBuffer!,
    endOfStream: Boolean
): Unit
```

Invoked when data is read into the buffer passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)`. Only part of the buffer may be populated. To continue reading, call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)`. It may be invoked after `
onResponseTrailersReceived()`, if there was pending read data before trailers were received.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream on which the read completed |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information |
| `buffer: https://developer.android.com/reference/java/nio/ByteBuffer.html!` | the buffer that was passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)`, now containing the received data. The buffer's limit is not changed. The buffer's position is set to the end of the received data. If position is not updated, it means the remote side has signaled that it will send no more data. |
| `endOfStream: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | if true, this is the last read data, remote will not send more data, and the read side is closed. |

### onResponseHeadersReceived

```
abstract fun onResponseHeadersReceived(
    stream: BidirectionalStream!,
    info: UrlResponseInfo!
): Unit
```

Invoked when initial response headers are received. Headers are available from `
info.``https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo#getAllHeaders()`. Consumer may call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)` to start reading. Consumer may call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)` to start writing or close the stream.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream on which response headers were received. |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information. |

### onResponseTrailersReceived

```
fun onResponseTrailersReceived(
    stream: BidirectionalStream!,
    info: UrlResponseInfo!,
    trailers: UrlResponseInfo.HeaderBlock!
): Unit
```

Invoked when trailers are received before closing the stream. Only invoked when server sends trailers, which it may not. May be invoked while there is read data remaining in local buffer. Default implementation takes no action.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream on which response trailers were received |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information |
| `trailers: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo.HeaderBlock!` | the trailers received |

### onStreamReady

```
abstract fun onStreamReady(stream: BidirectionalStream!): Unit
```

Invoked when the stream is ready for reading and writing. Consumer may call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#read(java.nio.ByteBuffer)` to start reading data. Consumer may call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)` to start writing data.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream that is ready. |

### onSucceeded

```
abstract fun onSucceeded(stream: BidirectionalStream!, info: UrlResponseInfo!): Unit
```

Invoked when there is no data to be read or written and the stream is closed successfully remotely and locally. Once invoked, no further `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream.Callback` methods will be invoked.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream which is closed successfully |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information |

### onWriteCompleted

```
abstract fun onWriteCompleted(
    stream: BidirectionalStream!,
    info: UrlResponseInfo!,
    buffer: ByteBuffer!,
    endOfStream: Boolean
): Unit
```

Invoked when the entire ByteBuffer passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)` is sent. The buffer's position is updated to be the same as the buffer's limit. The buffer's limit is not changed. To continue writing, call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)`.

| Parameters |
|---|---|
| `stream: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream!` | the stream on which the write completed |
| `info: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo!` | the response information |
| `buffer: https://developer.android.com/reference/java/nio/ByteBuffer.html!` | the buffer that was passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)`. The buffer's position is set to the buffer's limit. The buffer's limit is not changed. |
| `endOfStream: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | the endOfStream flag that was passed to the corresponding `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/BidirectionalStream#write(java.nio.ByteBuffer,boolean)`. If true, the write side is closed. |