Trait/Object

com.lightbend.lagom.scaladsl.api

ServiceCall

Related Docs: object ServiceCall | package api

Permalink

trait ServiceCall[Request, Response] extends AnyRef

A service call for an entity.

A service call has a request and a response entity. Either entity may be NotUsed, if there is no entity associated with the call. They may also be an Akka streams Source, in situations where the endpoint serves a stream. In all other cases, the entities will be considered "strict" entities, that is, they will be parsed into memory, eg, using json.

Source
ServiceCall.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServiceCall
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def invoke(request: Request): Future[Response]

    Permalink

    Invoke the service call.

    Invoke the service call.

    request

    The request entity.

    returns

    A future of the response entity.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to any2stringadd[ServiceCall[Request, Response]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ServiceCall[Request, Response], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to ArrowAssoc[ServiceCall[Request, Response]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ServiceCall[Request, Response]) ⇒ Boolean, msg: ⇒ Any): ServiceCall[Request, Response]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to Ensuring[ServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ServiceCall[Request, Response]) ⇒ Boolean): ServiceCall[Request, Response]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to Ensuring[ServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ServiceCall[Request, Response]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to Ensuring[ServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ServiceCall[Request, Response]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to Ensuring[ServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to StringFormat[ServiceCall[Request, Response]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def handleRequestHeader(handler: (RequestHeader) ⇒ RequestHeader): ServiceCall[Request, Response]

    Permalink

    Make any modifications necessary to the request header.

    Make any modifications necessary to the request header.

    For client service calls, this gives clients an opportunity to add custom headers and/or modify the request in some way before it is made. The passed in handler is applied before the header transformers configured for the descriptor/endpoint are applied.

    For server implementations of service calls, this will be invoked by the server in order to supply the request header. A new service call can then be returned that uses the header. The header passed in to the handler by the service call can be anything, it will be ignored - RequestHeader#DEFAULT exists for this purpose. Generally, server implementations should not implement this method directly, rather, they should use ServerServiceCall, which provides an appropriate implementation.

    handler

    A function that takes in the request header representing the request, and transforms it.

    returns

    A service call that will use the given handler.

  18. def handleResponseHeader[T](handler: (ResponseHeader, Response) ⇒ T): ServiceCall[Request, T]

    Permalink

    Transform the response using the given function that takes the response header and the response.

    Transform the response using the given function that takes the response header and the response.

    For client service calls, this gives clients an opportunity to inspect the response headers and status code. The passed in handler is applied after the header transformers configured for the descriptor/endpoint are applied.

    For server implementations of service calls, this will be invoked by the server in order to give the service call an opportunity to supply the response header when it supplies the response, but only if the underlying transport supports sending a response header. Generally, server implementations should not implement this method directly, rather, they should use ServerServiceCall, which provides an appropriate implementation.

    handler

    The handler.

    returns

    A service call that uses the given handler.

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. def invoke()(implicit evidence: =:=[Request, NotUsed]): Future[Response]

    Permalink

    Invoke the service call with unit id argument and a unit request message.

    Invoke the service call with unit id argument and a unit request message.

    This should only be used when the request message is NotUsed.

    returns

    A future of the response entity.

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withResponseHeader: ServiceCall[Request, (ResponseHeader, Response)]

    Permalink

    Allow handling of the response header.

    Allow handling of the response header.

    This converts the service call to one that returns both the response header and the response message.

    This is simply a convenience method for invoking handleResponseHeader((_, _).

    returns

    The a service call that returns the response header and the response message.

  31. def [B](y: B): (ServiceCall[Request, Response], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceCall[Request, Response] to ArrowAssoc[ServiceCall[Request, Response]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ServiceCall[Request, Response] to any2stringadd[ServiceCall[Request, Response]]

Inherited by implicit conversion StringFormat from ServiceCall[Request, Response] to StringFormat[ServiceCall[Request, Response]]

Inherited by implicit conversion Ensuring from ServiceCall[Request, Response] to Ensuring[ServiceCall[Request, Response]]

Inherited by implicit conversion ArrowAssoc from ServiceCall[Request, Response] to ArrowAssoc[ServiceCall[Request, Response]]

Ungrouped