Packages

object StatusReply

Source
StatusReply.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StatusReply
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class ErrorMessage(errorMessage: String) extends RuntimeException with NoStackTrace with Product with Serializable

    Carrier exception used for textual error descriptions.

    Carrier exception used for textual error descriptions.

    Not meant for usage outside of StatusReply.

Value Members

  1. val Ack: StatusReply[Done]

    Scala API: A general purpose message for using as an Ack

  2. def ack(): StatusReply[Done]

    Java API: A general purpose message for using as an Ack

  3. def error[T](exception: Throwable): StatusReply[T]

    Java API: Create an error response with a user defined Throwable.

    Java API: Create an error response with a user defined Throwable.

    Prefer the string based error response over this one when possible to avoid tightly coupled logic across actors and passing internal failure details on to callers that can not do much to handle them.

    For cases where types are needed to identify errors and behave differently enumerating them with a specific set of response messages may be a better alternative to encoding them as generic exceptions.

    Also note that Akka does not contain pre-build serializers for arbitrary exceptions.

  4. def error[T](errorMessage: String): StatusReply[T]

    Java API: Create an status response with a error message describing why the request was failed or denied.

  5. def success[T](value: T): StatusReply[T]

    Java API: Create a successful reply containing value

  6. object Error

    Scala API for creating and pattern matching an error response

    Scala API for creating and pattern matching an error response

    For example: case StatusReply.Error(exception) => ...

  7. object Success

    Scala API for creation and pattern matching a successful response.

    Scala API for creation and pattern matching a successful response.

    For example: case StatusReply.Success(value: String) => ...