aboutsummaryrefslogtreecommitdiff
path: root/docs/backends/summary.rst
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2018-02-20 10:25:21 +0100
committeradamw <adam@warski.org>2018-02-20 10:25:21 +0100
commit893ecf5aa990c11a0264231552766e4cf901deee (patch)
treef78d7cb7d8fb757ee8788c30ff2d2b8a136ab54f /docs/backends/summary.rst
parent0f2ad1a1ef77364f0776232a88992e8cba30d28d (diff)
downloadsttp-893ecf5aa990c11a0264231552766e4cf901deee.tar.gz
sttp-893ecf5aa990c11a0264231552766e4cf901deee.tar.bz2
sttp-893ecf5aa990c11a0264231552766e4cf901deee.zip
Brave backend docs
Diffstat (limited to 'docs/backends/summary.rst')
-rw-r--r--docs/backends/summary.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/backends/summary.rst b/docs/backends/summary.rst
index 72b20c9..d648c73 100644
--- a/docs/backends/summary.rst
+++ b/docs/backends/summary.rst
@@ -3,7 +3,7 @@
Supported backends
==================
-sttp suports a number of synchornous and asynchronous backends. It's the backends that take care of managing connections, sending requests and receiving responses: sttp defines only the API to describe the requests to be send and handle the response data. It's the backends where all the heavy-lifting is done.
+sttp suports a number of synchronous and asynchronous backends. It's the backends that take care of managing connections, sending requests and receiving responses: sttp defines only the API to describe the requests to be send and handle the response data. It's the backends where all the heavy-lifting is done.
Choosing the right backend depends on a number of factors: if you are using sttp to explore some data, or is it a production system; are you using a synchronous, blocking architecture or an asynchronous one; do you work mostly with Scala's ``Future``, or maybe you use some form of a ``Task`` abstraction; finally, if you want to stream requests/responses, or not.
@@ -30,3 +30,7 @@ Class Response wrapper Supported stream t
``OkHttpMonixBackend`` ``monix.eval.Task`` ``monix.reactive.Observable[ByteBuffer]``
================================ ============================ ================================================
+There are also backends which wrap other backends to provide additional functionality. These include:
+
+* ``TryBackend``, which safely wraps any exceptions thrwon by a synchronous backend in ``scala.util.Try``
+* ``BraveBackend``, for Zipkin-compatible distributed tracing. See the :ref:`dedicated section <brave>`. \ No newline at end of file