Interface IReadEventAdapter
Facility to convert from specialised data models, as may be required by specialized persistence Journals.
Typical use cases include (but are not limited to):
- extracting events from "envelopes"
- manually converting to the Journals storage format, such as JSON, BSON or any specialised binary format
- adapting incoming events from a "data model" to the "domain model"
Namespace: Akka.Persistence.Journal
Assembly: Akka.Persistence.dll
Syntax
public interface IReadEventAdapter
Methods
| Improve this Doc View SourceFromJournal(Object, String)
Convert an event from its journal model to the application's domain model.
One event may be adapter into multiple(or none) events which should be delivered to the PersistentActor. Use the specialised Single(Object) method to emit exactly one event, or Empty in case the adapter is not handling this event. Multiple IEventAdapter instances are applied in order as defined in configuration and their emitted event seqs are concatenated and delivered in order to the PersistentActor.
Declaration
IEventSequence FromJournal(object evt, string manifest)
Parameters
Type | Name | Description |
---|---|---|
Object | evt | event to be adapted before delivering to the PersistentActor |
String | manifest | optionally provided manifest(type hint) in case the Adapter has stored one for this event. Use empty string if none. |
Returns
Type | Description |
---|---|
IEventSequence | sequence containing the adapted events (possibly zero) which will be delivered to the PersistentActor |