kgal-core/kgal.statistics

Package-level declarations

Types

Link copied to clipboard
sealed interface LogNote

A session note linked to a State for describing activity of GA per Session.

Link copied to clipboard
data class Session(val id: Int, val logNotes: List<LogNote>)

Session describes activity of GA from first State.STARTED state to State.FINISHED.

Link copied to clipboard
@JvmInline
value class SessionsInfo(val sessions: List<Session>)

SessionsInfo helper container for collecting Session of GA.

Link copied to clipboard
typealias STAT_COLLECTOR = FlowCollector<StatisticNote<Any?>>
Link copied to clipboard
typealias STAT_COLLECTOR_SCOPE = suspend CoroutineScope.(stat: Flow<StatisticNote<Any?>>) -> Unit
Link copied to clipboard
interface StatisticsConfig

Configuration of basic parameters for statistics operation.

Link copied to clipboard
class StatisticsConfigScope(var replay: Int = DEFAULT_REPLAY, var extraBufferCapacity: Int = DEFAULT_EXTRA_BUFFER_CAPACITY, var onBufferOverflow: BufferOverflow = DEFAULT_ON_BUFFER_OVERFLOW, var coroutineContext: CoroutineContext = DEFAULT_COROUTINE_CONTEXT, var enableDefaultCollector: Boolean = DEFAULT_ENABLE_DEFAULT_COLLECTOR, var defaultCollector: STAT_COLLECTOR_SCOPE = DEFAULT_COLLECTOR, var guaranteedSorted: Boolean = DEFAULT_GUARANTEED_SORTED) : StatisticsConfig

StatisticsConfigScope - Creating StatisticsConfig with Kotlin DSL style.

Link copied to clipboard
interface StatisticsProvider

StatisticsProvider - interface for Statistics Provider based on SharedFlow.

Link copied to clipboard
Link copied to clipboard
data class TimeStore(val onStarted: MutableList<TimeMarker>, val onIteration: MutableList<TimeMarker>, val onFinished: MutableList<TimeMarker>, val onStopped: MutableList<TimeMarker>)

Store for all TimeMarkers of GA.

Properties

Link copied to clipboard
val GA<*, *>.allSessions: SessionsInfo

Creates SessionsInfo that describes all activity of GA.

Link copied to clipboard
val StatisticsConfig.flow: MutableSharedFlow<StatisticNote<Any?>>

Creates a new MutableSharedFlow for StatisticNote with StatisticsConfig params.

Link copied to clipboard
val StatisticsConfig.newCoroutineScope: CoroutineScope

Creates a new CoroutineScope with SupervisorJob and StatisticsConfig.coroutineContext

Functions

Link copied to clipboard
fun TimeStore.clear()

Clear all time markers.

Link copied to clipboard
fun StatisticsConfig(replay: Int = DEFAULT_REPLAY, extraBufferCapacity: Int = DEFAULT_EXTRA_BUFFER_CAPACITY, onBufferOverflow: BufferOverflow = DEFAULT_ON_BUFFER_OVERFLOW, coroutineContext: CoroutineContext = DEFAULT_COROUTINE_CONTEXT, enableDefaultCollector: Boolean = DEFAULT_ENABLE_DEFAULT_COLLECTOR, defaultCollector: STAT_COLLECTOR_SCOPE = DEFAULT_COLLECTOR, guaranteedSorted: Boolean = DEFAULT_GUARANTEED_SORTED): StatisticsConfig

Creates StatisticsConfig.

Link copied to clipboard