Search Results for

    Show / Hide Table of Contents

    Class DistributedPubSubSettings

    TBD

    Inheritance
    object
    DistributedPubSubSettings
    Implements
    INoSerializationVerificationNeeded
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Cluster.Tools.PublishSubscribe
    Assembly: Akka.Cluster.Tools.dll
    Syntax
    public sealed class DistributedPubSubSettings : INoSerializationVerificationNeeded

    Constructors

    | Edit this page View Source

    DistributedPubSubSettings(string, RoutingLogic, TimeSpan, TimeSpan, int, bool)

    Creates a new instance of the DistributedPubSubSettings.

    Declaration
    public DistributedPubSubSettings(string role, RoutingLogic routingLogic, TimeSpan gossipInterval, TimeSpan removedTimeToLive, int maxDeltaElements, bool sendToDeadLettersWhenNoSubscribers)
    Parameters
    Type Name Description
    string role

    The role that will host DistributedPubSubMediator instances.

    RoutingLogic routingLogic

    Optional. The routing logic used for distributing messages for topic groups.

    TimeSpan gossipInterval

    The gossip interval for propagating topic/subscriber data to other mediators.

    TimeSpan removedTimeToLive

    The amount of time it takes to prune a deactivated subscriber from the network.

    int maxDeltaElements

    The maximum number of delta elements that can be propagated in a single gossip tick.

    bool sendToDeadLettersWhenNoSubscribers

    When a message is published to a topic with no subscribers send it to the dead letters.

    Exceptions
    Type Condition
    ArgumentException

    Thrown if a user tries to use a ConsistentHashingRoutingLogic with routingLogic.

    Properties

    | Edit this page View Source

    GossipInterval

    How often the DistributedPubSubMediator should send out gossip information

    Declaration
    public TimeSpan GossipInterval { get; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    MaxDeltaElements

    Maximum number of elements to transfer in one message when synchronizing the registries. Next chunk will be transferred in next round of gossip.

    Declaration
    public int MaxDeltaElements { get; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    RemovedTimeToLive

    Removed entries are pruned after this duration.

    Declaration
    public TimeSpan RemovedTimeToLive { get; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    Role

    The mediator starts on members tagged with this role. Uses all if undefined.

    Declaration
    public string Role { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    RoutingLogic

    The routing logic to use for DistributedPubSubMediator.

    Declaration
    public RoutingLogic RoutingLogic { get; }
    Property Value
    Type Description
    RoutingLogic
    | Edit this page View Source

    SendToDeadLettersWhenNoSubscribers

    When a message is published to a topic with no subscribers send it to the dead letters.

    Declaration
    public bool SendToDeadLettersWhenNoSubscribers { get; }
    Property Value
    Type Description
    bool

    Methods

    | Edit this page View Source

    Create(ActorSystem)

    Creates cluster publish/subscribe settings from the default configuration akka.cluster.pub-sub.

    Declaration
    public static DistributedPubSubSettings Create(ActorSystem system)
    Parameters
    Type Name Description
    ActorSystem system

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    Exceptions
    Type Condition
    ArgumentException

    TBD

    | Edit this page View Source

    Create(Config)

    Creates cluster publish subscribe settings from provided configuration with the same layout as akka.cluster.pub-sub.

    Declaration
    public static DistributedPubSubSettings Create(Config config)
    Parameters
    Type Name Description
    Config config

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    Exceptions
    Type Condition
    ArgumentException

    TBD

    | Edit this page View Source

    WithGossipInterval(TimeSpan)

    TBD

    Declaration
    public DistributedPubSubSettings WithGossipInterval(TimeSpan gossipInterval)
    Parameters
    Type Name Description
    TimeSpan gossipInterval

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    | Edit this page View Source

    WithMaxDeltaElements(int)

    TBD

    Declaration
    public DistributedPubSubSettings WithMaxDeltaElements(int maxDeltaElements)
    Parameters
    Type Name Description
    int maxDeltaElements

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    | Edit this page View Source

    WithRemovedTimeToLive(TimeSpan)

    TBD

    Declaration
    public DistributedPubSubSettings WithRemovedTimeToLive(TimeSpan removedTtl)
    Parameters
    Type Name Description
    TimeSpan removedTtl

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    | Edit this page View Source

    WithRole(string)

    TBD

    Declaration
    public DistributedPubSubSettings WithRole(string role)
    Parameters
    Type Name Description
    string role

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    | Edit this page View Source

    WithRoutingLogic(RoutingLogic)

    TBD

    Declaration
    public DistributedPubSubSettings WithRoutingLogic(RoutingLogic routingLogic)
    Parameters
    Type Name Description
    RoutingLogic routingLogic

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    TBD

    | Edit this page View Source

    WithSendToDeadLettersWhenNoSubscribers(bool)

    TBD

    Declaration
    public DistributedPubSubSettings WithSendToDeadLettersWhenNoSubscribers(bool sendToDeadLetterWhenNoSubscribers)
    Parameters
    Type Name Description
    bool sendToDeadLetterWhenNoSubscribers

    TBD

    Returns
    Type Description
    DistributedPubSubSettings

    Implements

    INoSerializationVerificationNeeded

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET