EventStore API

IChronicleClient

Entry point for the library.

interface IChronicleClient {
    fun getEventStore(name: String): IEventStore
    fun getEventStore(name: String, namespace: String): IEventStore
    fun close()
}

Factory functions:

ChronicleClient.development()                          // localhost:35000
ChronicleClient(options: ChronicleOptions)             // custom host/port

---

IEventStore

interface IEventStore {
    val eventLog: IEventLog
    val reactors: IReactorsService
    val reducers: IReducersService
    val projections: IProjectionsService
    val constraints: IConstraintsService
    val seeding: IEventSeedingService
    val readModels: IReadModelsService
    val compliance: IComplianceService
    val unitOfWork: UnitOfWorkManager
}

---

IEventLog

interface IEventLog {
    suspend fun append(eventSourceId: String, event: Any): AppendResult
    suspend fun append(
        eventSourceId: String,
        event: Any,
        options: AppendOptions
    ): AppendResult
    suspend fun appendMany(
        eventSourceId: String,
        events: List<Any>
    ): List<AppendResult>
}

AppendResult

Property	Type	Description
isSuccess	Boolean	true when no constraint violations
sequenceNumber	EventSequenceNumber	Position in the event log
constraintViolations	List<ConstraintViolation>	On failure

---

IReactorsService

interface IReactorsService {
    suspend fun register(reactor: Any): Job
}

---

IReducersService

interface IReducersService {
    suspend fun register(reducer: Any): Job
}

---

IReadModelsService

interface IReadModelsService {
    suspend fun register(vararg readModelClasses: KClass<*>)
    suspend fun <T : Any> getInstanceByKey(
        readModelClass: KClass<T>,
        key: String
    ): T?
}

---

IProjectionsService

interface IProjectionsService {
    suspend fun register(vararg projections: Any)
}

---

IConstraintsService

interface IConstraintsService {
    suspend fun register(vararg constraints: Any)
}

---

IEventSeedingService

interface IEventSeedingService {
    suspend fun seed(vararg seeders: Any)
}

---

IComplianceService

interface IComplianceService {
    suspend fun release(subject: String, schema: String, payload: String): String
}