rename

Author: hoc081098

channel-event-bus/src/commonMain/kotlin/com/hoc081098/channeleventbus/ChannelEvent.kt

@@ -15,6 +15,16 @@ public interface ChannelEvent<T : ChannelEvent<T>> {
    */
   public val key: Key<T>
 
+  /**
+   * The [ChannelEvent.Key] to identify a bus for this type of events.
+   *
+   * @param T the type of events.
+   * @param eventClass the [KClass] of events.
+   * @param capacity the [ChannelEventBusCapacity] of the [Channel] associated with this key.
+   * Default is [ChannelEventBusCapacity.UNLIMITED].
+   *
+   * @see [ChannelEventBusCapacity]
+   */
   public open class Key<T : ChannelEvent<T>>(
     @JvmField
     internal val eventClass: KClass<T>,
@@ -24,12 +34,12 @@ public interface ChannelEvent<T : ChannelEvent<T>> {
     final override fun equals(other: Any?): Boolean {
       if (this === other) return true
       if (other !is Key<*>) return false
-      return eventClass == other.eventClass
+      return eventClass == other.eventClass && capacity == other.capacity
     }
 
-    final override fun hashCode(): Int = eventClass.hashCode()
+    final override fun hashCode(): Int = 31 * eventClass.hashCode() + capacity.hashCode()
 
-    final override fun toString(): String = "ChannelEvent.Key(${eventClass.simpleName})"
+    final override fun toString(): String = "ChannelEvent.Key(${eventClass.simpleName}, $capacity)"
 
     @JvmSynthetic
     internal inline fun cast(it: Any): T = eventClass.cast(it)
@@ -56,5 +66,6 @@ public typealias ChannelEventKey<T> = ChannelEvent.Key<T>
  * bus.receiveAsFlow(awesomeEventKey).collect { e: AwesomeEvent -> println(e) }
  * ```
  */
-public inline fun <reified T : ChannelEvent<T>> channelEventKeyOf(): ChannelEventKey<T> =
-  ChannelEventKey(T::class)
+public inline fun <reified T : ChannelEvent<T>> channelEventKeyOf(
+  capacity: ChannelEventBusCapacity = ChannelEventBusCapacity.UNLIMITED,
+): ChannelEventKey<T> = ChannelEventKey(T::class, capacity)

channel-event-bus/src/commonMain/kotlin/com/hoc081098/channeleventbus/ChannelEventBus.kt

@@ -30,7 +30,7 @@ import kotlinx.coroutines.internal.synchronized as coroutinesSynchronized
  * - [ChannelEvent.Key] will be used to identify a bus for a specific type of events.
  *   Each bus has a [Channel] to send events to and a [Flow] to receive events from.
  *
- * - The [Channel] is unbounded [Channel.UNLIMITED].
+ * - The [Channel] is unbounded [Channel.UNLIMITED] (default) or conflated [Channel.CONFLATED].
  *   The [Flow] is cold and only one collector is allowed at a time.
  *   This make sure all events are consumed.
  *

channel-event-bus/src/commonMain/kotlin/com/hoc081098/channeleventbus/ChannelEventBusCapacity.kt

@@ -1,6 +1,7 @@
 package com.hoc081098.channeleventbus
 
 import kotlin.jvm.JvmSynthetic
+import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.channels.Channel
 
 @JvmSynthetic
@@ -11,14 +12,31 @@ internal inline fun ChannelEventBusCapacity.asInt(): Int {
   }
 }
 
+/**
+ * The capacity of the [Channel] associated with a [ChannelEvent.Key].
+ *
+ * @see [ChannelEvent.Key.capacity]
+ */
 public enum class ChannelEventBusCapacity {
   /**
    * The [Channel] is unbounded [Channel.UNLIMITED].
+   *
+   * The [Channel] associated with a [ChannelEvent.Key] will has an unlimited capacity buffer.
+   * This means that the [Channel] will never suspend the sender and will never drop elements.
+   *
+   * @see [Channel.UNLIMITED]
    */
   UNLIMITED,
 
   /**
    * The [Channel] is bounded [Channel.CONFLATED].
+   *
+   * The [Channel] associated with a [ChannelEvent.Key] will has a conflated capacity buffer.
+   * The size of buffer is 1 and will keep only the most recently sent element (drop the oldest element).
+   * This means that the [Channel] will never suspend the sender, but will drop the oldest element when buffer is full.
+   *
+   * @see [Channel.CONFLATED]
+   * @see [BufferOverflow.DROP_OLDEST]
    */
   CONFLATED,
 }

sample/app/src/main/java/com/hoc081098/channeleventbus/sample/android/ui/register/events.kt

@@ -1,22 +1,23 @@
 package com.hoc081098.channeleventbus.sample.android.ui.register
 
 import com.hoc081098.channeleventbus.ChannelEvent
+import com.hoc081098.channeleventbus.ChannelEventBusCapacity.CONFLATED
 import com.hoc081098.channeleventbus.ChannelEventKey
 
 internal data class SubmitFirstNameEvent(val value: String?) : ChannelEvent<SubmitFirstNameEvent> {
   override val key get() = Key
 
-  companion object Key : ChannelEventKey<SubmitFirstNameEvent>(SubmitFirstNameEvent::class)
+  companion object Key : ChannelEventKey<SubmitFirstNameEvent>(SubmitFirstNameEvent::class, CONFLATED)
 }
 
 internal data class SubmitLastNameEvent(val value: String?) : ChannelEvent<SubmitLastNameEvent> {
   override val key get() = Key
 
-  companion object Key : ChannelEventKey<SubmitLastNameEvent>(SubmitLastNameEvent::class)
+  companion object Key : ChannelEventKey<SubmitLastNameEvent>(SubmitLastNameEvent::class, CONFLATED)
 }
 
 internal data class SubmitGenderEvent(val value: Gender?) : ChannelEvent<SubmitGenderEvent> {
   override val key get() = Key
 
-  companion object Key : ChannelEventKey<SubmitGenderEvent>(SubmitGenderEvent::class)
+  companion object Key : ChannelEventKey<SubmitGenderEvent>(SubmitGenderEvent::class, CONFLATED)
 }