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
- Alphabetic
- By Inheritance
- ServiceCall
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- 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
-
def
->[B](y: B): (ServiceCall[Request, Response], B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (ServiceCall[Request, Response]) ⇒ Boolean, msg: ⇒ Any): ServiceCall[Request, Response]
- Implicit
- 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
-
def
ensuring(cond: (ServiceCall[Request, Response]) ⇒ Boolean): ServiceCall[Request, Response]
- Implicit
- 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
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ServiceCall[Request, Response]
- Implicit
- 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
-
def
ensuring(cond: Boolean): ServiceCall[Request, Response]
- Implicit
- 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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
handleRequestHeader(handler: (RequestHeader) ⇒ RequestHeader): ServiceCall[Request, Response]
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.
-
def
handleResponseHeader[T](handler: (ResponseHeader, Response) ⇒ T): ServiceCall[Request, T]
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.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
invoke()(implicit evidence: =:=[NotUsed, Request]): Future[Response]
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.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withResponseHeader: ServiceCall[Request, (ResponseHeader, Response)]
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.
-
def
→[B](y: B): (ServiceCall[Request, Response], B)
- Implicit
- 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