abstract class ReadSideHandler[Event <: AggregateEvent[Event]] extends AnyRef
An read side offset processor.
This is responsible for the actual read side handling, including handling offsets and the events themselves.
- Source
 - ReadSideProcessor.scala
 
- Alphabetic
 - By Inheritance
 
- ReadSideHandler
 - AnyRef
 - Any
 
- by any2stringadd
 - by StringFormat
 - by Ensuring
 - by ArrowAssoc
 
- Hide All
 - Show All
 
- Public
 - All
 
Instance Constructors
-  new ReadSideHandler()
 
Abstract Value Members
- 
      
      
      
        
      
    
      
        abstract 
        def
      
      
        handle(): Flow[EventStreamElement[Event], Done, NotUsed]
      
      
      
Flow to handle the events.
Flow to handle the events.
If the handler does any blocking, this flow should be configured to use a dispatcher that is configured to allow for that blocking.
 
Concrete Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        +(other: String): String
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to any2stringadd[ReadSideHandler[Event]] performed by method any2stringadd in scala.Predef.
 - Definition Classes
 - any2stringadd
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ->[B](y: B): (ReadSideHandler[Event], B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to ArrowAssoc[ReadSideHandler[Event]] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (ReadSideHandler[Event]) ⇒ Boolean, msg: ⇒ Any): ReadSideHandler[Event]
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (ReadSideHandler[Event]) ⇒ Boolean): ReadSideHandler[Event]
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean, msg: ⇒ Any): ReadSideHandler[Event]
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean): ReadSideHandler[Event]
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to Ensuring[ReadSideHandler[Event]] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( classOf[java.lang.Throwable] )
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        formatted(fmtstr: String): String
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to StringFormat[ReadSideHandler[Event]] performed by method StringFormat in scala.Predef.
 - Definition Classes
 - StringFormat
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        globalPrepare(): Future[Done]
      
      
      
Prepare the database for all processors.
Prepare the database for all processors.
This will be invoked at system startup. It is guaranteed to only be invoked once at a time across the entire cluster, and so is safe to be used to perform actions like creating tables, that could cause problems if done from multiple nodes.
It will be invoked again if it fails, and it may be invoked multiple times as nodes of the cluster go up or down. Unless the entire system is restarted, there is no way to guarantee that it will be invoked at a particular time - in particular, it should not be used for doing upgrades unless the entire system is restarted and a new cluster built from scratch.
- returns
 A
Futurethat is redeemed when preparation is finished.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        prepare(tag: AggregateEventTag[Event]): Future[Offset]
      
      
      
Prepare this processor.
Prepare this processor.
The primary purpose of this method is to load the last offset that was processed, so that read side processing can continue from that offset.
This also provides an opportunity for processors to do any initialisation activities, such as creating or updating database tables, or migrating data.
This will be invoked at least once for each tag, and may be invoked multiple times, such as in the event of failure.
- tag
 The tag to get the offset for.
- returns
 A
Futurethat is redeemed when preparation is finished.
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        →[B](y: B): (ReadSideHandler[Event], B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from ReadSideHandler[Event] to ArrowAssoc[ReadSideHandler[Event]] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc