Class PersistenceSupervisor

    Akka.Pattern.BackoffSupervisor implementation that buffers un-delivered and un-persisted messages down to a Akka.Persistence.PersistentActor child.

    Inheritance
    System.Object
    PersistenceSupervisor
    Namespace:Akka.Persistence.Extras
    Assembly:Akka.Persistence.Extras.dll
    Syntax
    public class PersistenceSupervisor : ActorBase

    Constructors

    PersistenceSupervisor(Func<IActorRef, Props>, String, IPersistenceSupervisionConfig, SupervisorStrategy)

    Declaration
    public PersistenceSupervisor(Func<IActorRef, Props> childProps, string childName, IPersistenceSupervisionConfig config, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Func<IActorRef, Props> childProps
    System.String childName
    IPersistenceSupervisionConfig config
    SupervisorStrategy strategy

    PersistenceSupervisor(Props, String, IPersistenceSupervisionConfig, SupervisorStrategy)

    Declaration
    public PersistenceSupervisor(Props childProps, string childName, IPersistenceSupervisionConfig config, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Props childProps
    System.String childName
    IPersistenceSupervisionConfig config
    SupervisorStrategy strategy

    Fields

    Log

    Declaration
    protected readonly ILoggingAdapter Log
    Field Value
    Type Description
    ILoggingAdapter

    Properties

    Child

    Declaration
    protected IActorRef Child { get; set; }
    Property Value
    Type Description
    IActorRef

    ChildName

    Declaration
    protected string ChildName { get; }
    Property Value
    Type Description
    System.String

    ChildProps

    Declaration
    protected Func<IActorRef, Props> ChildProps { get; }
    Property Value
    Type Description
    Func<IActorRef, Props>

    FinalStopMessage

    Declaration
    protected Func<object, bool> FinalStopMessage { get; }
    Property Value
    Type Description
    Func<System.Object, System.Boolean>

    FinalStopMessageReceived

    Declaration
    protected bool FinalStopMessageReceived { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsEvent

    Declaration
    protected Func<object, bool> IsEvent { get; }
    Property Value
    Type Description
    Func<System.Object, System.Boolean>

    MakeEventConfirmable

    Declaration
    protected Func<object, long, IConfirmableMessage> MakeEventConfirmable { get; }
    Property Value
    Type Description
    Func<System.Object, System.Int64, IConfirmableMessage>

    Reset

    Declaration
    protected IBackoffReset Reset { get; }
    Property Value
    Type Description
    IBackoffReset

    RestartCountN

    Declaration
    protected int RestartCountN { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    CheckIsEvent(Object)

    Declaration
    protected virtual bool CheckIsEvent(object message)
    Parameters
    Type Name Description
    System.Object message
    Returns
    Type Description
    System.Boolean

    DoMakeEventConfirmable(Object, Int64)

    Declaration
    protected virtual IConfirmableMessage DoMakeEventConfirmable(object message, long deliveryId)
    Parameters
    Type Name Description
    System.Object message
    System.Int64 deliveryId
    Returns
    Type Description
    IConfirmableMessage

    HandleBackoff(Object)

    Declaration
    protected bool HandleBackoff(object message)
    Parameters
    Type Name Description
    System.Object message
    Returns
    Type Description
    System.Boolean

    HandleMsg(Object, IActorRef)

    Declaration
    protected void HandleMsg(object message, IActorRef sender = null)
    Parameters
    Type Name Description
    System.Object message
    IActorRef sender

    OnChildRecreate()

    Declaration
    protected virtual void OnChildRecreate()

    PreStart()

    Declaration
    protected override void PreStart()

    PropsFor(Func<IActorRef, Props>, String, IBackoffReset, Func<Object, Boolean>, SupervisorStrategy)

    Overload for users who ARE ALREADY USING IConfirmableMessage by the time the message is received by the PersistenceSupervisor.

    If a message is received by the PersistenceSupervisor without being decorated by IConfirmableMessage, under this configuration we will automatically package your message inside a ConfirmableMessageEnvelope.

    Declaration
    public static Props PropsFor(Func<IActorRef, Props> childPropsFactory, string childName, IBackoffReset reset = null, Func<object, bool> finalStopMsg = null, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Func<IActorRef, Props> childPropsFactory
    System.String childName
    IBackoffReset reset
    Func<System.Object, System.Boolean> finalStopMsg
    SupervisorStrategy strategy
    Returns
    Type Description
    Props
    Remarks

    Read the manual. Seriously.

    PropsFor(Func<Object, Int64, IConfirmableMessage>, Func<Object, Boolean>, Func<IActorRef, Props>, String, IBackoffReset, Func<Object, Boolean>, SupervisorStrategy)

    Declaration
    public static Props PropsFor(Func<object, long, IConfirmableMessage> makeConfirmable, Func<object, bool> isEvent, Func<IActorRef, Props> childPropsFactory, string childName, IBackoffReset reset = null, Func<object, bool> finalStopMsg = null, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Func<System.Object, System.Int64, IConfirmableMessage> makeConfirmable
    Func<System.Object, System.Boolean> isEvent
    Func<IActorRef, Props> childPropsFactory
    System.String childName
    IBackoffReset reset
    Func<System.Object, System.Boolean> finalStopMsg
    SupervisorStrategy strategy
    Returns
    Type Description
    Props

    PropsFor(Func<Object, Int64, IConfirmableMessage>, Func<Object, Boolean>, Props, String, IBackoffReset, Func<Object, Boolean>, SupervisorStrategy)

    Declaration
    public static Props PropsFor(Func<object, long, IConfirmableMessage> makeConfirmable, Func<object, bool> isEvent, Props childProps, string childName, IBackoffReset reset = null, Func<object, bool> finalStopMsg = null, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Func<System.Object, System.Int64, IConfirmableMessage> makeConfirmable
    Func<System.Object, System.Boolean> isEvent
    Props childProps
    System.String childName
    IBackoffReset reset
    Func<System.Object, System.Boolean> finalStopMsg
    SupervisorStrategy strategy
    Returns
    Type Description
    Props

    PropsFor(Props, String, IBackoffReset, Func<Object, Boolean>, SupervisorStrategy)

    Overload for users who ARE ALREADY USING IConfirmableMessage by the time the message is received by the PersistenceSupervisor.

    If a message is received by the PersistenceSupervisor without being decorated by IConfirmableMessage, under this configuration we will automatically package your message inside a ConfirmableMessageEnvelope.

    Declaration
    public static Props PropsFor(Props childProps, string childName, IBackoffReset reset = null, Func<object, bool> finalStopMsg = null, SupervisorStrategy strategy = null)
    Parameters
    Type Name Description
    Props childProps
    System.String childName
    IBackoffReset reset
    Func<System.Object, System.Boolean> finalStopMsg
    SupervisorStrategy strategy
    Returns
    Type Description
    Props
    Remarks

    Read the manual. Seriously.

    Receive(Object)

    Declaration
    protected override bool Receive(object message)
    Parameters
    Type Name Description
    System.Object message
    Returns
    Type Description
    System.Boolean

    SupervisorStrategy()

    Declaration
    protected override SupervisorStrategy SupervisorStrategy()
    Returns
    Type Description
    SupervisorStrategy