aboutsummaryrefslogtreecommitdiff
path: root/docs/conf/timeouts.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf/timeouts.rst')
-rw-r--r--docs/conf/timeouts.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/conf/timeouts.rst b/docs/conf/timeouts.rst
new file mode 100644
index 0000000..72b2f4a
--- /dev/null
+++ b/docs/conf/timeouts.rst
@@ -0,0 +1,23 @@
+Timeouts
+========
+
+Sttp supports read and connection timeouts:
+
+* Connection timeout - can be set globally (30 seconds by default)
+* Read timeout - can be set per request (1 minute by default)
+
+How to use::
+
+ import com.softwaremill.sttp._
+ import scala.concurrent.duration._
+
+ // all backends provide a constructor that allows users to specify backend options
+ implicit val backend = HttpURLConnectionBackend(
+ options = SttpBackendOptions.connectionTimeout(1.minute))
+
+ sttp
+ .get(uri"...")
+ .readTimeout(5.minutes) // or Duration.Inf to turn read timeout off
+ .send()
+
+