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:

val proxy = context.actorOf(Props(new ReliableProxy(target)))

or in Java:

final ActorRef proxy = getContext().actorOf(new Props(new UntypedActorFactory() {
  public Actor create() {
    return new ReliableProxy(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
FSM[ReliableProxy.State, Vector[Message]], ActorLogging, Listeners, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReliableProxy
  2. FSM
  3. ActorLogging
  4. Listeners
  5. Actor
  6. AnyRef
  7. Any
  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 extends Product with Serializable

    Definition Classes
    FSM
  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 extends Product with Serializable

    Definition Classes
    FSM
  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. val ->: actor.FSM.->.type

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

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

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

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

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

    Definition Classes
    FSM
  10. def clone(): AnyRef

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  12. final def eq(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef → Any
  16. def gossip(msg: Any)(implicit sender: ActorRef): Unit

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

    Definition Classes
    FSM
  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. final def initialize: Unit

    Definition Classes
    FSM
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def listenerManagement: actor.Actor.Receive

    Attributes
    protected
    Definition Classes
    Listeners
  22. val listeners: Set[ActorRef]

    Attributes
    protected
    Definition Classes
    Listeners
  23. val log: LoggingAdapter

    Definition Classes
    ActorLogging
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. var nextSerial: Int

  26. final def nextStateData: Vector[Message]

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

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

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

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

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

    Definition Classes
    Actor
  32. def postStop(): Unit

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

    Definition Classes
    Actor
  34. def preStart(): Unit

    Definition Classes
    Actor
  35. def receive: Receive

    Definition Classes
    FSM
  36. def scheduleTick(): Unit

  37. implicit final val self: ActorRef

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

  39. final def sender: ActorRef

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

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

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

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

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

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

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

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

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

    Definition Classes
    FSM
  49. def supervisorStrategy: OneForOneStrategy

    Definition Classes
    ReliableProxy → Actor
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. final def timerActive_?(name: String): Boolean

    Definition Classes
    FSM
  52. def toString(): String

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

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

    Definition Classes
    FSM
  55. val tunnel: ActorRef

  56. def unhandled(message: Any): Unit

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

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

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

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

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

    Definition Classes
    FSM

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

Inherited from ActorLogging

Inherited from Listeners

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped