3.9.0-rc 3.8.0 (latest) 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 2.48.0-rc 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.1 2.24.0 2.23.0 2.22.1 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.1 2.14.0 2.13.0 2.12.0 2.11.0 The `*Connection` object for [`AsyncReader`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReader).
Applications should have little need to use this class directly. They should use [`AsyncReader`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReader) instead, which provides an easier to use interface.

In tests, this class can be used to mock the behavior of [`AsyncReader`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReader).

## Functions

### Cancel()

Cancels the current download.
Callers should continue reading until [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) is satisfied with a [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `void` |   |

### Read()

Asks for more data.
An outcome with a [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html) indicates that no more data is available. Calling [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) after it returns a [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html) results in undefined behavior.

Applications should not have more than one [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) pending at a time. Calling [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) while a previous [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) is pending results in undefined behavior.

Applications should not destruct an [`AsyncReaderConnection`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection) until a call to [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2) returns a [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html) response.

Retrieving more data can result in three outcomes:

- Additional data (a [`ReadPayload`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1ReadPayload)) is available: in this case the future is satisfied with a `ReadResponse` containing a [`ReadPayload`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1ReadPayload).
- The download is interrupted with an error: in this case the future is satisfied with a `ReadResponse` containing a [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html) that describes the error.
- The download has completed successfully: in this case the future is satisfied with a `ReadResponse` containing an OK [`Status`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1Status.html).

A [`StatusOr`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1StatusOr.html)`<>` cannot represent the last bullet point, so we need an `std::variant<>` in this case. We could have used [`StatusOr`](https://docs.cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1StatusOr.html)`<std::optional<`[`ReadPayload`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1ReadPayload)`>>` but that sounds unnecessarily complicated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `future< ReadResponse >` |   |

### GetRequestMetadata()

Return the request metadata.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `RpcMetadata` |   |

## Type Aliases

### ReadResponse

**Alias Of** : `std::variant< ReadPayload, Status >` The value returned by [`Read()`](https://docs.cloud.google.com/cpp/docs/reference/storage/latest/classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection#classgoogle_1_1cloud_1_1storage_1_1AsyncReaderConnection_1ac3d76d5918797a932d31319248b302e2). See the function for more details.