akka.contrib.pattern

ReliableProxy

class ReliableProxy extends Actor with FSM[State, Vector[Message]]

A ReliableProxy is a means to wrap a remote actor reference in order to obtain certain improved delivery guarantees:

These guarantees are valid for the communication between the two end-points of the reliable “tunnel”, which usually spans an unreliable network. Delivery from the remote end-point to the target actor is still subject to in-JVM delivery semantics (i.e. not strictly guaranteed due to possible OutOfMemory situations or other VM errors).

You can create a reliable connection like this:

In Scala:

val proxy = context.actorOf(Props(classOf[ReliableProxy], target))

In Java:

final ActorRef proxy = getContext().actorOf(Props.create(ReliableProxy.class target));

Please note: the tunnel is uni-directional, and original sender information is retained, hence replies by the wrapped target reference will go back in the normal “unreliable” way unless also secured by a ReliableProxy from the remote end.

Message Types

This actor is an akka.actor.FSM, hence it offers the service of transition callbacks to those actors which subscribe using the SubscribeTransitionCallBack and UnsubscribeTransitionCallBack messages; see akka.actor.FSM for more documentation. The proxy will transition into ReliableProxy.Active state when ACKs are outstanding and return to the ReliableProxy.Idle state when every message send so far has been confirmed by the peer end-point. Any other message type sent to this actor will be delivered via a remote-deployed child actor to the designated target. Message types declared in the companion object are for internal use only and not to be sent from the outside.

Failure Cases

All failures of either the local or the remote end-point are escalated to the parent of this actor; there are no specific error cases which are predefined.

Arguments

target is the akka.actor.ActorRef to which all messages will be forwarded which are sent to this actor. It can be any type of actor reference, but the “remote” tunnel endpoint will be deployed on the node where the target ref points to.

retryAfter is the ACK timeout after which all outstanding messages will be resent. There is not limit on the queue size or the number of retries.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReliableProxy
  2. FSM
  3. ActorLogging
  4. Listeners
  5. Actor
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReliableProxy(target: ActorRef, retryAfter: FiniteDuration)

Type Members

  1. case class Event(event: Any, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    All messages sent to the akka.actor.FSM will be wrapped inside an Event, which allows pattern matching to extract both state and data.

  2. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor
  3. type State = actor.FSM.State[ReliableProxy.State, Vector[Message]]

    Definition Classes
    FSM
  4. type StateFunction = PartialFunction[Event, State]

    Definition Classes
    FSM
  5. case class StopEvent(reason: Reason, currentState: S, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    Case class representing the state of the akka.actor.FSM whithin the onTermination block.

  6. type Timeout = Option[FiniteDuration]

    Definition Classes
    FSM
  7. final class TransformHelper extends AnyRef

    Definition Classes
    FSM
  8. type TransitionHandler = PartialFunction[(ReliableProxy.State, ReliableProxy.State), Unit]

    Definition Classes
    FSM

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. val ->: actor.FSM.->.type

    This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

    This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

    Definition Classes
    FSM
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. val StateTimeout: actor.FSM.StateTimeout.type

    This case object is received in case of a state timeout.

    This case object is received in case of a state timeout.

    Definition Classes
    FSM
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. final def cancelTimer(name: String): Unit

    Cancel named timer, ensuring that the message is not subsequently delivered (no race).

    Cancel named timer, ensuring that the message is not subsequently delivered (no race).

    name

    of the timer to cancel

    Definition Classes
    FSM
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. implicit val context: ActorContext

    Stores the context for this actor, including self, and sender.

    Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  13. def ensuring(cond: (ReliableProxy) ⇒ Boolean, msg: ⇒ Any): ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to Ensuring[ReliableProxy] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (ReliableProxy) ⇒ Boolean): ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to Ensuring[ReliableProxy] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to Ensuring[ReliableProxy] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to Ensuring[ReliableProxy] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def gossip(msg: Any)(implicit sender: ActorRef = Actor.noSender): Unit

    Sends the supplied message to all current listeners using the provided sender as sender.

    Sends the supplied message to all current listeners using the provided sender as sender.

    msg
    sender

    Attributes
    protected
    Definition Classes
    Listeners
  23. final def goto(nextStateName: ReliableProxy.State): State

    Produce transition to other state.

    Produce transition to other state. Return this from a state function in order to effect the transition.

    nextStateName

    state designator for the next state

    returns

    state transition descriptor

    Definition Classes
    FSM
  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  25. final def initialize(): Unit

    Verify existence of initial state and setup timers.

    Verify existence of initial state and setup timers. This should be the last call within the constructor, or akka.actor.Actor#preStart and akka.actor.Actor#postRestart

    Definition Classes
    FSM
    See also

    #startWith

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. final def isTimerActive(name: String): Boolean

    Inquire whether the named timer is still active.

    Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.

    Definition Classes
    FSM
  28. def listenerManagement: actor.Actor.Receive

    Chain this into the receive function.

    Chain this into the receive function.

    def receive = listenerManagement orElse ￉
    Attributes
    protected
    Definition Classes
    Listeners
  29. val listeners: Set[ActorRef]

    Attributes
    protected
    Definition Classes
    Listeners
  30. val log: LoggingAdapter

    Definition Classes
    ActorLogging
  31. def logTermination(reason: Reason): Unit

    By default FSM.Failure is logged at error level and other reason types are not logged.

    By default FSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.

    Attributes
    protected
    Definition Classes
    FSM
  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. var nextSerial: Int

  34. final def nextStateData: Vector[Message]

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Definition Classes
    FSM
  35. final def notify(): Unit

    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  37. final def onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit

    Set handler which is called upon termination of this FSM actor.

    Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.

    Definition Classes
    FSM
  38. final def onTransition(transitionHandler: TransitionHandler): Unit

    Set handler which is called upon each state transition, i.

    Set handler which is called upon each state transition, i.e. not when staying in the same state. This may use the pair extractor defined in the FSM companion object like so:

    onTransition {
      case Old -> New => doSomething
    }
    

    It is also possible to supply a 2-ary function object:

    onTransition(handler _)
    
    private def handler(from: S, to: S) { ... }
    

    The underscore is unfortunately necessary to enable the nicer syntax shown above (it uses the implicit conversion total2pf under the hood).

    Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

    Definition Classes
    FSM
  39. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  40. def postStop(): Unit

    Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().

    Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().

    Please note that this method is called by default from preRestart(), so override that one if onTermination shall not be called during restart.

    Definition Classes
    FSMActor
  41. def preRestart(reason: Throwable, message: Option[Any]): Unit

    User overridable callback: By default it disposes of all children and then calls postStop().

    User overridable callback: By default it disposes of all children and then calls postStop().

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  42. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  43. def receive: Receive

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    FSMActor
  44. def scheduleTick(): Unit

  45. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself:

    self ! message
    

    Definition Classes
    Actor
  46. def send(msg: Any): Message

  47. final def sender: ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  48. final def setStateTimeout(state: ReliableProxy.State, timeout: Timeout): Unit

    Set state timeout explicitly.

    Set state timeout explicitly. This method can safely be used from within a state handler.

    Definition Classes
    FSM
  49. final def setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean): Unit

    Schedule named timer to deliver message after given delay, possibly repeating.

    Schedule named timer to deliver message after given delay, possibly repeating.

    name

    identifier to be used with cancelTimer()

    msg

    message to be delivered

    timeout

    delay of first message delivery and between subsequent messages

    repeat

    send once if false, scheduleAtFixedRate if true

    returns

    current state descriptor

    Definition Classes
    FSM
  50. final def startWith(stateName: ReliableProxy.State, stateData: Vector[Message], timeout: Timeout = None): Unit

    Set initial state.

    Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.

    stateName

    initial state designator

    stateData

    initial state data

    timeout

    state timeout for the initial state, overriding the default timeout for that state

    Definition Classes
    FSM
  51. final def stateData: Vector[Message]

    Return current state data (i.

    Return current state data (i.e. object of type D)

    Definition Classes
    FSM
  52. final def stateName: ReliableProxy.State

    Return current state name (i.

    Return current state name (i.e. object of type S)

    Definition Classes
    FSM
  53. final def stay(): State

    Produce "empty" transition descriptor.

    Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.

    returns

    descriptor for staying in current state

    Definition Classes
    FSM
  54. final def stop(reason: Reason, stateData: Vector[Message]): State

    Produce change descriptor to stop this FSM actor including specified reason.

    Produce change descriptor to stop this FSM actor including specified reason.

    Definition Classes
    FSM
  55. final def stop(reason: Reason): State

    Produce change descriptor to stop this FSM actor including specified reason.

    Produce change descriptor to stop this FSM actor including specified reason.

    Definition Classes
    FSM
  56. final def stop(): State

    Produce change descriptor to stop this FSM actor with reason "Normal".

    Produce change descriptor to stop this FSM actor with reason "Normal".

    Definition Classes
    FSM
  57. def supervisorStrategy: OneForOneStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    ReliableProxyActor
  58. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  59. def toString(): String

    Definition Classes
    AnyRef → Any
  60. implicit final def total2pf(transitionHandler: (ReliableProxy.State, ReliableProxy.State) ⇒ Unit): TransitionHandler

    Convenience wrapper for using a total function instead of a partial function literal.

    Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.

    Definition Classes
    FSM
  61. final def transform(func: StateFunction): TransformHelper

    Definition Classes
    FSM
  62. val tunnel: ActorRef

  63. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Actor
  64. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def when(stateName: ReliableProxy.State, stateTimeout: FiniteDuration = null)(stateFunction: StateFunction): Unit

    Insert a new StateFunction at the end of the processing chain for the given state.

    Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.

    stateName

    designator for the state

    stateTimeout

    default state timeout for this state

    stateFunction

    partial function describing response to input

    Definition Classes
    FSM
  68. final def whenUnhandled(stateFunction: StateFunction): Unit

    Set handler which is called upon reception of unhandled messages.

    Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.

    The current state may be queried using stateName.

    Definition Classes
    FSM
  69. def [B](y: B): (ReliableProxy, B)

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to ArrowAssoc[ReliableProxy] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def ->[B](y: B): (ReliableProxy, B)

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to ArrowAssoc[ReliableProxy] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (reliableProxy: ArrowAssoc[ReliableProxy]).->(y)
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (reliableProxy: StringAdd).self
    Definition Classes
    StringAdd
  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (reliableProxy: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. final def timerActive_?(name: String): Boolean

    Inquire whether the named timer is still active.

    Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.

    Definition Classes
    FSM
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use isTimerActive instead

  2. def x: ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to ArrowAssoc[ReliableProxy] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (reliableProxy: ArrowAssoc[ReliableProxy]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: ReliableProxy

    Implicit information
    This member is added by an implicit conversion from ReliableProxy to Ensuring[ReliableProxy] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (reliableProxy: Ensuring[ReliableProxy]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from FSM[ReliableProxy.State, Vector[Message]]

Inherited from ActorLogging

Inherited from Listeners

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ReliableProxy to StringAdd

Inherited by implicit conversion any2stringfmt from ReliableProxy to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ReliableProxy to ArrowAssoc[ReliableProxy]

Inherited by implicit conversion any2Ensuring from ReliableProxy to Ensuring[ReliableProxy]

Ungrouped