Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.2 KB

streaming.md

File metadata and controls

34 lines (23 loc) · 1.2 KB
Raw

Streaming

Some backends (see backends summary) support streaming bodies. If that's the case, you can set a stream of the supported type as a request body using the streamBody method, instead of the usual body method.

.. note::

 Here, streaming refers to (usually) non-blocking, asynchronous streams of data. To send data which is available as an ``InputStream``, or a file from local storage (which is available as a ``File`` or ``Path``), no special backend support is needed. See the documenttation on `setting the request body <body.html>`_.

For example, using the akka-http backend, a request with a streaming body can be defined as follows:

import sttp.client._
import sttp.client.akkahttp._

import akka.stream.scaladsl.Source
import akka.util.ByteString

val source: Source[ByteString, Any] =   ...

basicRequest
  .streamBody(source)
  .post(uri"...")
.. note:: A request with the body set as a stream can only be sent using a backend supporting exactly the given type of streams.

It's also possible to specify that the response body should be a stream.