diff options
Diffstat (limited to 'core/src/main/scala')
-rw-r--r-- | core/src/main/scala/com/softwaremill/sttp/SttpHandler.scala | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/core/src/main/scala/com/softwaremill/sttp/SttpHandler.scala b/core/src/main/scala/com/softwaremill/sttp/SttpHandler.scala index f0f1fc9..0562fc2 100644 --- a/core/src/main/scala/com/softwaremill/sttp/SttpHandler.scala +++ b/core/src/main/scala/com/softwaremill/sttp/SttpHandler.scala @@ -2,6 +2,12 @@ package com.softwaremill.sttp import scala.language.higherKinds +/** + * @tparam R The type constructor in which responses are wrapped. E.g. `Id` + * for synchronous handlers, `Future` for asynchronous handlers. + * @tparam S The type of streams that are supported by the handler. `Nothing`, + * if streaming requests/responses is not supported by this handler. + */ trait SttpHandler[R[_], -S] { def send[T](request: Request[T, S]): R[Response[T]] } |