surf

Request

Related Docs: object Request | package surf

trait Request extends Completable

A completable request that provides access to the corresponding response in a future.

Linear Supertypes
Completable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. Completable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def annotations: Map[String, Any]

  2. abstract def complete(resp: Response): Unit

    Completes the request (flow) with the provided Response.

    Completes the request (flow) with the provided Response.

    resp

    either a successful response or a failure.

    Definition Classes
    Completable
    Exceptions thrown

    RequestAlreadyCompletedException if the request has already been completed

    Note

    A request can only be completed once!

  3. abstract def future: Future[Any]

    Returns a future that will be completed when this request (flow) is completed.

    Returns a future that will be completed when this request (flow) is completed.

    Definition Classes
    Completable
  4. abstract def input: Any

    The request message.

  5. abstract def isCompleted: Boolean

    Returns true iff the request has been completed

    Returns true iff the request has been completed

    Definition Classes
    Completable
  6. abstract def map(fInput: (Any) ⇒ Any)(fOutput: (Any) ⇒ Any): Request

    Returns a new request with the same completion target as the current request, but the original input is transformed by fInput, and the response is transformed by fOutput.

    Returns a new request with the same completion target as the current request, but the original input is transformed by fInput, and the response is transformed by fOutput.

    fInput
    fOutput

  7. abstract def onComplete(f: PartialFunction[Try[Any], Any]): Request

    Maps the request input, if f is defined for this input.

    Maps the request input, if f is defined for this input. Otherwise the the current request is completed with completeWith.

    f

    partial function that maps the request input, if it is defined for this input value

    Definition Classes
    RequestCompletable
  8. abstract def onFailure(f: PartialFunction[Throwable, Any]): Request

    The specified function is called when the request fails.

    The specified function is called when the request fails.

    f

    function to be called on failure.

    Definition Classes
    RequestCompletable
  9. abstract def onSuccess(f: PartialFunction[Any, Any]): Request

    The specified function is called when the request is completed successfully

    The specified function is called when the request is completed successfully

    f

    function to be called on successful completion

    Definition Classes
    RequestCompletable
  10. abstract def withAnnotations(f: (Map[String, Any]) ⇒ Map[String, Any]): Request

Concrete Value Members

  1. final def !(resp: Any): Unit

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  5. final def >>(service: ServiceRef): Request

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. final def failure(ex: Throwable): Unit

    Completes the request (flow) with a failure

    Completes the request (flow) with a failure

    ex

    Exception indicating the failure

    Definition Classes
    Completable
    Exceptions thrown

    RequestAlreadyCompletedException if the request has already been completed

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. def mapInput(fInput: (Any) ⇒ Any): Request

  16. def mapOutput(fOutput: (Any) ⇒ Any): Request

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. final def success(result: Any): Unit

    Completes the request (flow) successfully with the provided response result.

    Completes the request (flow) successfully with the provided response result.

    result

    The result data object

    Definition Classes
    Completable
    Exceptions thrown

    RequestAlreadyCompletedException if the request has already been completed

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  22. def toString(): String

    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def withInput(input: Any): Request

Inherited from Completable

Inherited from AnyRef

Inherited from Any

Ungrouped