object StatusReply
- Source
- StatusReply.scala
- Alphabetic
- By Inheritance
- StatusReply
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val Ack: StatusReply[Done]
Scala API: A general purpose message for using as an Ack
- def ack(): StatusReply[Done]
Java API: A general purpose message for using as an Ack
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- 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.
- 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.
- 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.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def success[T](value: T): StatusReply[T]
Java API: Create a successful reply containing
value - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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) => ... - 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) => ...