Packages

object StatusReply

Source
StatusReply.scala
Linear Supertypes
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Ack: StatusReply[Done]

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

  5. def ack(): StatusReply[Done]

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

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. 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.

  11. 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.

  12. def fromTry[T](status: Try[T]): StatusReply[T]

    Scala API: Turn a try into a status reply.

    Scala API: Turn a try into a status reply.

    Transforms exceptions into status reply errors containing just the exception message string.

    See #fromTryKeepException for passing the exception along as is.

  13. def fromTryKeepException[T](status: Try[T]): StatusReply[T]

    Scala API: Turn a Try into a status reply.

    Scala API: Turn a Try into a status reply.

    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. #fromTry provides a convenience factory doing that for scala.util.Try.

    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-built serializers for arbitrary exceptions.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def success[T](value: T): StatusReply[T]

    Java API: Create a successful reply containing value

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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) => ...

  27. 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) => ...

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped