akka.persistence.journal
Interface SyncWriteJournal

All Superinterfaces:
Actor, AsyncRecovery, WriteJournalBase
All Known Implementing Classes:
LeveldbJournal, SyncWriteJournal

public interface SyncWriteJournal
extends Actor, WriteJournalBase, AsyncRecovery

Abstract journal, optimized for synchronous writes.


Nested Class Summary
 
Nested classes/interfaces inherited from interface akka.actor.Actor
Actor.emptyBehavior$
 
Method Summary
 void deleteMessages(scala.collection.immutable.Seq<PersistentId> messageIds, boolean permanent)
          Plugin API: synchronously deletes messages identified by messageIds from the journal.
 void deleteMessagesTo(java.lang.String persistenceId, long toSequenceNr, boolean permanent)
          Plugin API: synchronously deletes all persistent messages up to toSequenceNr (inclusive).
 Persistence extension()
           
 boolean publish()
           
 scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
          This defines the initial actor behavior, it must return a partial function with the actor logic.
 void writeConfirmations(scala.collection.immutable.Seq<PersistentConfirmation> confirmations)
          Plugin API: synchronously writes a batch of delivery confirmations to the journal.
 void writeMessages(scala.collection.immutable.Seq<PersistentRepr> messages)
          Plugin API: synchronously writes a batch of persistent messages to the journal.
 
Methods inherited from interface akka.actor.Actor
aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, postRestart, postStop, preRestart, preStart, self, sender, supervisorStrategy, unhandled
 
Methods inherited from interface akka.persistence.journal.WriteJournalBase
persistentPrepareWrite, preparePersistentBatch
 
Methods inherited from interface akka.persistence.journal.AsyncRecovery
asyncReadHighestSequenceNr, asyncReplayMessages
 

Method Detail

extension

Persistence extension()

publish

boolean publish()

receive

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
Description copied from interface: Actor
This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:
receive in interface Actor
Returns:
(undocumented)

writeMessages

void writeMessages(scala.collection.immutable.Seq<PersistentRepr> messages)
Plugin API: synchronously writes a batch of persistent messages to the journal. The batch write must be atomic i.e. either all persistent messages in the batch are written or none.

Parameters:
messages - (undocumented)

writeConfirmations

void writeConfirmations(scala.collection.immutable.Seq<PersistentConfirmation> confirmations)
Plugin API: synchronously writes a batch of delivery confirmations to the journal.

Parameters:
confirmations - (undocumented)

deleteMessages

void deleteMessages(scala.collection.immutable.Seq<PersistentId> messageIds,
                    boolean permanent)
Plugin API: synchronously deletes messages identified by messageIds from the journal. If permanent is set to false, the persistent messages are marked as deleted, otherwise they are permanently deleted.

Parameters:
messageIds - (undocumented)
permanent - (undocumented)

deleteMessagesTo

void deleteMessagesTo(java.lang.String persistenceId,
                      long toSequenceNr,
                      boolean permanent)
Plugin API: synchronously deletes all persistent messages up to toSequenceNr (inclusive). If permanent is set to false, the persistent messages are marked as deleted, otherwise they are permanently deleted.

Parameters:
persistenceId - (undocumented)
toSequenceNr - (undocumented)
permanent - (undocumented)