Class DistributedPubSubSettings

TBD

Inheritance

object

DistributedPubSubSettings

Implements

INoSerializationVerificationNeeded

IEquatable<DistributedPubSubSettings>

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 record DistributedPubSubSettings : INoSerializationVerificationNeeded, IEquatable<DistributedPubSubSettings>

Constructors

| Edit this page View Source

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

Creates a new instance of the DistributedPubSubSettings.

Declaration

[Obsolete("Use .ctor that supports WaitForSubscribers instead. Since 1.4.42")]
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.

| Edit this page View Source

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

Creates a new instance of the DistributedPubSubSettings.

Declaration

public DistributedPubSubSettings(string role, RoutingLogic routingLogic, TimeSpan gossipInterval, TimeSpan removedTimeToLive, int maxDeltaElements, bool sendToDeadLettersWhenNoSubscribers, int maxBufferedMessagePerTopic, TimeSpan bufferedMessageTimeoutCheckInterval)

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.
int	maxBufferedMessagePerTopic	Maximum message buffer size for each topic
TimeSpan	bufferedMessageTimeoutCheckInterval	Buffered message timeout condition check interval

Exceptions

Type	Condition
ArgumentException	Thrown if a user tries to use a ConsistentHashingRoutingLogic with routingLogic.

Properties

| Edit this page View Source

BufferedMessageTimeoutCheckInterval

Determine the interval on which all buffered PublishWithAck message will be checked for timeout condition

Declaration

public TimeSpan BufferedMessageTimeoutCheckInterval { get; }

Property Value

Type	Description
TimeSpan

| 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

MaxBufferedMessagePerTopic

The maximum PublishWithAck message buffer size for each topic

Declaration

public int MaxBufferedMessagePerTopic { get; }

Property Value

Type	Description
int

| 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

WithBufferedMessageTimeoutCheckInterval(TimeSpan)

Declaration

public DistributedPubSubSettings WithBufferedMessageTimeoutCheckInterval(TimeSpan bufferedMessageTimeoutCheckInterval)

Parameters

Type	Name	Description
TimeSpan	bufferedMessageTimeoutCheckInterval

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithGossipInterval(TimeSpan)

Declaration

public DistributedPubSubSettings WithGossipInterval(TimeSpan gossipInterval)

Parameters

Type	Name	Description
TimeSpan	gossipInterval

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithMaxBufferedMessagePerTopic(int)

Declaration

public DistributedPubSubSettings WithMaxBufferedMessagePerTopic(int maxBufferedMessagePerTopic)

Parameters

Type	Name	Description
int	maxBufferedMessagePerTopic

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithMaxDeltaElements(int)

Declaration

public DistributedPubSubSettings WithMaxDeltaElements(int maxDeltaElements)

Parameters

Type	Name	Description
int	maxDeltaElements

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithRemovedTimeToLive(TimeSpan)

Declaration

public DistributedPubSubSettings WithRemovedTimeToLive(TimeSpan removedTtl)

Parameters

Type	Name	Description
TimeSpan	removedTtl

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithRole(string)

Declaration

public DistributedPubSubSettings WithRole(string role)

Parameters

Type	Name	Description
string	role

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithRoutingLogic(RoutingLogic)

Declaration

public DistributedPubSubSettings WithRoutingLogic(RoutingLogic routingLogic)

Parameters

Type	Name	Description
RoutingLogic	routingLogic

Returns

Type	Description
DistributedPubSubSettings

| Edit this page View Source

WithSendToDeadLettersWhenNoSubscribers(bool)

Declaration

public DistributedPubSubSettings WithSendToDeadLettersWhenNoSubscribers(bool sendToDeadLetterWhenNoSubscribers)

Parameters

Type	Name	Description
bool	sendToDeadLetterWhenNoSubscribers

Returns

Type	Description
DistributedPubSubSettings

Implements

INoSerializationVerificationNeeded

IEquatable<T>

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)