Trait/Object

diode.data

AsyncActionRetriable

Related Docs: object AsyncActionRetriable | package data

Permalink

trait AsyncActionRetriable[A, P <: AsyncActionRetriable[A, P]] extends AsyncAction[A, P]

A retriable version of AsyncAction. Implementation must define a retryPolicy, which is also passed on in the next method.

A

Type of action result

P

Type of the actual action class

Linear Supertypes
AsyncAction[A, P], Action, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncActionRetriable
  2. AsyncAction
  3. Action
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def next(newState: PotState, newValue: Try[A], newRetryPolicy: RetryPolicy): P

    Permalink
  2. abstract def result: Try[A]

    Permalink
    Definition Classes
    AsyncAction
  3. abstract def retryPolicy: RetryPolicy

    Permalink
  4. abstract def state: PotState

    Permalink
    Definition Classes
    AsyncAction

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. implicit object PActionType extends ActionType[P]

    Permalink
    Definition Classes
    AsyncAction
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def effect[B](f: ⇒ Future[B])(success: (B) ⇒ A, failure: (Throwable) ⇒ Throwable = identity)(implicit ec: ExecutionContext): EffectSingle[P]

    Permalink

    Wraps a by-name future result into an effect using success and failure transformations.

    Wraps a by-name future result into an effect using success and failure transformations.

    f

    Future to wrap, passes using by-name (lazy evaluation)

    success

    Transformation function for success case

    failure

    Transformation function for failure case

    returns

    An Effect for running the provided Future

    Definition Classes
    AsyncAction
  8. def effectWithRetry[B](f: ⇒ Future[B])(success: (B) ⇒ A, failure: (Throwable) ⇒ Throwable = identity)(implicit ec: ExecutionContext): (RetryPolicy) ⇒ EffectSingle[P]

    Permalink

    Wraps a by-name future result into an effect creator function, using success and failure transformations.

    Wraps a by-name future result into an effect creator function, using success and failure transformations.

    f

    Future to wrap, passes using by-name (lazy evaluation)

    success

    Transformation function for success case

    failure

    Transformation function for failure case

    returns

    An Effect for running the provided Future

  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def failed(ex: Throwable, nextRetryPolicy: RetryPolicy = retryPolicy): P

    Permalink

    Moves this action to a failed state with the provided exception.

    Moves this action to a failed state with the provided exception.

    ex

    Exception describing the reason for failure

    nextRetryPolicy

    Updated retry policy

  12. def failed(ex: Throwable): P

    Permalink

    Moves this action to a failed state with the provided exception.

    Moves this action to a failed state with the provided exception.

    ex

    Reason for the failure.

    Definition Classes
    AsyncAction
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def handle[M](pf: PartialFunction[PotState, ActionResult[M]]): ActionResult[M]

    Permalink

    Handles the action using the supplied partial function matching current state.

    Handles the action using the supplied partial function matching current state.

    Definition Classes
    AsyncAction
  16. def handleWith[M, T](handler: ActionHandler[M, T], effectRetry: (RetryPolicy) ⇒ Effect)(f: (AsyncActionRetriable.this.type, ActionHandler[M, T], (RetryPolicy) ⇒ Effect) ⇒ ActionResult[M]): ActionResult[M]

    Permalink

    Handles the action using an external handler function.

    Handles the action using an external handler function. The function is provided with instance of this AsyncAction, the ActionHandler this action currently resides in and the provided update Effect creator function. The reason why retry policy is provided to the effect creator is that in case of failure, the updated retry policy can be passed on to the next effect instantiation.

    handler

    The current action handler instance.

    effectRetry

    Function taking current RetryPolicy and returning an effect that performs the requested async operation.

    f

    External handler function

    returns

    An action result

  17. def handleWith[M, T](handler: ActionHandler[M, T], effect: Effect)(f: (AsyncActionRetriable.this.type, ActionHandler[M, T], Effect) ⇒ ActionResult[M]): ActionResult[M]

    Permalink

    Handles the action using an external handler function.

    Handles the action using an external handler function. The function is provided with instance of this AsyncAction, the ActionHandler this action currently resides in and the provided update Effect.

    handler

    The current action handler instance.

    effect

    Effect that performs the requested async operation.

    f

    External handler function

    returns

    An action result

    Definition Classes
    AsyncAction
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  21. def next(newState: PotState, newValue: Try[A]): P

    Permalink

    Moves the action to the next state.

    Moves the action to the next state.

    newState

    New state for the action

    newValue

    New value for the action

    returns

    A new instance of this action with updated state and value

    Definition Classes
    AsyncActionRetriableAsyncAction
  22. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  24. def pending: P

    Permalink

    Moves this action to pending state.

    Moves this action to pending state.

    Definition Classes
    AsyncAction
  25. def ready(a: A): P

    Permalink

    Moves this action to ready state with a result value.

    Moves this action to ready state with a result value.

    a

    Result for the action.

    Definition Classes
    AsyncAction
  26. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AsyncAction[A, P]

Inherited from Action

Inherited from AnyRef

Inherited from Any

Ungrouped