Skip to content

//okhttp/okhttp3/ResponseBody

ResponseBody

[common]\ expect abstract class ResponseBody

A one-shot stream from the origin server to the client application with the raw bytes of the response body. Each response body is supported by an active connection to the webserver. This imposes both obligations and limits on the client application.

The response body must be closed.

Each response body is backed by a limited resource like a socket (live network responses) or an open file (for cached responses). Failing to close the response body will leak resources and may ultimately cause the application to slow down or crash.

Both this class and Response implement Closeable. Closing a response simply closes its response body. If you invoke Call.execute or implement Callback.onResponse you must close this body by calling any of the following methods:

  • Response.close()
  • Response.body().close()
  • Response.body().source().close()
  • Response.body().charStream().close()
  • Response.body().byteStream().close()
  • Response.body().bytes()
  • Response.body().string()

There is no benefit to invoking multiple close() methods for the same response body.

For synchronous calls, the easiest way to make sure a response body is closed is with a try block. With this structure the compiler inserts an implicit finally clause that calls close() for you.

Call call = client.newCall(request);\ try (Response response = call.execute()) {\ … // Use the response.\ }

You can use a similar block for asynchronous calls:

Call call = client.newCall(request);\ call.enqueue(new Callback() {\ public void onResponse(Call call, Response response) throws IOException {\ try (ResponseBody responseBody = response.body()) {\ … // Use the response.\ }\ }\ \ public void onFailure(Call call, IOException e) {\ … // Handle the failure.\ }\ });

These examples will not work if you’re consuming the response body on another thread. In such cases the consuming thread must call close when it has finished reading the response body.

The response body can be consumed only once.

This class may be used to stream very large responses. For example, it is possible to use this class to read a response that is larger than the entire memory allocated to the current process. It can even stream a response larger than the total storage on the current device, which is a common requirement for video streaming applications.

Because this class does not buffer the full response in memory, the application may not re-read the bytes of the response. Use this one shot to read the entire response into memory with bytes or string. Or stream the response with either source, byteStream, or charStream.

[jvm]\ actual abstract class ResponseBody : Closeable

[nonJvm]\ actual abstract class ResponseBody : Closeable

Constructors

ResponseBody [jvm, nonJvm]
fun ResponseBody()
[common]
expect fun ResponseBody()

Types

Name Summary
Companion [common, jvm, nonJvm]
[common]
expect object Companion
[jvm, nonJvm]
actual object Companion

Functions

Name Summary
bytes [common]
expect fun bytes(): ByteArray
Returns the response as a byte array.
[jvm, nonJvm]
[jvm, nonJvm]
actual fun bytes(): ByteArray
byteStream [jvm]
fun byteStream(): InputStream
byteString [common]
expect fun byteString(): <ERROR CLASS>
Returns the response as a ByteString.
[jvm, nonJvm]
[jvm, nonJvm]
actual fun byteString(): <ERROR CLASS>
charStream [jvm]
fun charStream(): Reader
Returns the response as a character stream.
close [common, jvm, nonJvm]
[common]
expect open fun close()
[jvm, nonJvm]
actual open override fun close()
contentLength [common]
expect abstract fun contentLength(): Long
Returns the number of bytes in that will returned by bytes, or byteStream, or -1 if unknown.
[jvm, nonJvm]
[jvm, nonJvm]
actual abstract fun contentLength(): Long
contentType [common, jvm, nonJvm]
[common]
expect abstract fun contentType(): MediaType?
[jvm, nonJvm]
actual abstract fun contentType(): MediaType?
source [common, jvm, nonJvm]
[common]
expect abstract fun source(): <ERROR CLASS>
[jvm, nonJvm]
actual abstract fun source(): <ERROR CLASS>
string [common]
expect fun string(): String
Returns the response as a string.
[jvm, nonJvm]
[jvm, nonJvm]
actual fun string(): String