akka.persistence
Class PersistentChannelSettings

java.lang.Object
  akka.persistence.PersistentChannelSettings

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class PersistentChannelSettings
extends java.lang.Object
implements scala.Product, scala.Serializable

A PersistentChannel configuration object.

param: redeliverMax Maximum number of redelivery attempts. param: redeliverInterval Interval between redelivery attempts. param: redeliverFailureListener Receiver of RedeliverFailure notifications which are sent when the number of redeliveries reaches redeliverMax for a sequence of messages. To enforce a redelivery of these messages, the listener has to Reset the persistent channel. Alternatively, it can also confirm these messages, preventing further redeliveries. param: replyPersistent If true the sender will receive the successfully stored Persistent message that has been submitted with a Deliver request, or a PersistenceFailure message in case of a persistence failure. param: pendingConfirmationsMax Message delivery is suspended by a channel if the number of pending reaches the specified value and is resumed again if the number of pending confirmations falls below pendingConfirmationsMin. param: pendingConfirmationsMin Message delivery is resumed if the number of pending confirmations falls below this limit. It is suspended again if it reaches pendingConfirmationsMax. Message delivery is enabled for a channel if the number of pending confirmations is below this limit, or, is resumed again if it falls below this limit. param: idleTimeout Maximum interval between read attempts made by a persistent channel. This settings applies, for example, after a journal failed to serve a read request. The next read request is then made after the configured timeout.

See Also:

Serialized Form

Constructor Summary

PersistentChannelSettings(int redeliverMax, scala.concurrent.duration.FiniteDuration redeliverInterval, scala.Option<ActorRef> redeliverFailureListener, boolean replyPersistent, long pendingConfirmationsMax, long pendingConfirmationsMin, scala.concurrent.duration.FiniteDuration idleTimeout)

Method Summary

static PersistentChannelSettings	create() Java API.
scala.concurrent.duration.FiniteDuration	idleTimeout()
long	pendingConfirmationsMax()
long	pendingConfirmationsMin()
scala.Option<ActorRef>	redeliverFailureListener()
scala.concurrent.duration.FiniteDuration	redeliverInterval()
int	redeliverMax()
boolean	replyPersistent()
ChannelSettings	toChannelSettings() Converts this configuration object to ChannelSettings.
PersistentChannelSettings	withIdleTimeout(scala.concurrent.duration.FiniteDuration idleTimeout) Java API.
PersistentChannelSettings	withPendingConfirmationsMax(long pendingConfirmationsMax) Java API.
PersistentChannelSettings	withPendingConfirmationsMin(long pendingConfirmationsMin) Java API.
PersistentChannelSettings	withRedeliverFailureListener(ActorRef redeliverFailureListener) Java API.
PersistentChannelSettings	withRedeliverInterval(scala.concurrent.duration.FiniteDuration redeliverInterval) Java API.
PersistentChannelSettings	withRedeliverMax(int redeliverMax) Java API.
PersistentChannelSettings	withReplyPersistent(boolean replayPersistent) Java API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

PersistentChannelSettings

public PersistentChannelSettings(int redeliverMax,
                                 scala.concurrent.duration.FiniteDuration redeliverInterval,
                                 scala.Option<ActorRef> redeliverFailureListener,
                                 boolean replyPersistent,
                                 long pendingConfirmationsMax,
                                 long pendingConfirmationsMin,
                                 scala.concurrent.duration.FiniteDuration idleTimeout)

Method Detail

create

public static PersistentChannelSettings create()

Java API.

Returns:

(undocumented)

redeliverMax

public int redeliverMax()

redeliverInterval

public scala.concurrent.duration.FiniteDuration redeliverInterval()

redeliverFailureListener

public scala.Option<ActorRef> redeliverFailureListener()

replyPersistent

public boolean replyPersistent()

pendingConfirmationsMax

public long pendingConfirmationsMax()

pendingConfirmationsMin

public long pendingConfirmationsMin()

idleTimeout

public scala.concurrent.duration.FiniteDuration idleTimeout()

withRedeliverMax

public PersistentChannelSettings withRedeliverMax(int redeliverMax)

Java API.

Parameters:

redeliverMax - (undocumented)

Returns:

(undocumented)

withRedeliverInterval

public PersistentChannelSettings withRedeliverInterval(scala.concurrent.duration.FiniteDuration redeliverInterval)

Java API.

Parameters:

redeliverInterval - (undocumented)

Returns:

(undocumented)

withRedeliverFailureListener

public PersistentChannelSettings withRedeliverFailureListener(ActorRef redeliverFailureListener)

Java API.

Parameters:

redeliverFailureListener - (undocumented)

Returns:

(undocumented)

withReplyPersistent

public PersistentChannelSettings withReplyPersistent(boolean replayPersistent)

Java API.

Parameters:

replayPersistent - (undocumented)

Returns:

(undocumented)

withPendingConfirmationsMax

public PersistentChannelSettings withPendingConfirmationsMax(long pendingConfirmationsMax)

Java API.

Parameters:

pendingConfirmationsMax - (undocumented)

Returns:

(undocumented)

withPendingConfirmationsMin

public PersistentChannelSettings withPendingConfirmationsMin(long pendingConfirmationsMin)

Java API.

Parameters:

pendingConfirmationsMin - (undocumented)

Returns:

(undocumented)

withIdleTimeout

public PersistentChannelSettings withIdleTimeout(scala.concurrent.duration.FiniteDuration idleTimeout)

Java API.

Parameters:

idleTimeout - (undocumented)

Returns:

(undocumented)

toChannelSettings

public ChannelSettings toChannelSettings()

Converts this configuration object to ChannelSettings.

Returns:

(undocumented)