add ICE events

Author: zoonooz

library/src/main/java/io/callstats/event/ice/IceAbortedEvent.kt

@@ -0,0 +1,28 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidate
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE Aborts, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param localIceCandidates list of local [IceCandidate]
+ * @param remoteIceCandidates list of remote [IceCandidate]
+ * @param iceCandidatePairs list of [IceCandidatePair]
+ * @param prevIceConnectionState current ice connection state "checking" or "new"
+ * @param delay delay in milliseconds (example: 3.5 seconds is 3500 in milliseconds)
+ */
+class IceAbortedEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val localIceCandidates: Array<IceCandidate>,
+    val remoteIceCandidates: Array<IceCandidate>,
+    val iceCandidatePairs: Array<IceCandidatePair>,
+    val prevIceConnectionState: String,
+    val delay: Int) : IceEvent()
+{
+  val eventType = "iceFailed"
+  val currIceConnectionState = "closed"
+}

library/src/main/java/io/callstats/event/ice/IceConnectionDisruptEndEvent.kt

@@ -0,0 +1,18 @@
+package io.callstats.event.ice
+
+/**
+ * When ICE connection disruption ends, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param delay delay in milliseconds (example: 3.5 seconds is 3500 in milliseconds)
+ */
+class IceConnectionDisruptEndEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val delay: Int) : IceEvent()
+{
+  val eventType = "iceConnectionDisruptionEnd"
+  val currIceConnectionState = "checking"
+  val prevIceConnectionState = "disconnected"
+}

library/src/main/java/io/callstats/event/ice/IceConnectionDisruptStartEvent.kt

@@ -0,0 +1,16 @@
+package io.callstats.event.ice
+
+/**
+ * When ICE connection disruption starts, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ */
+class IceConnectionDisruptStartEvent(
+    val remoteID: String,
+    val connectionID: String) : IceEvent()
+{
+  val eventType = "iceConnectionDisruptionStart"
+  val currIceConnectionState = "disconnected"
+  val prevIceConnectionState = "checking"
+}

library/src/main/java/io/callstats/event/ice/IceDisruptEndEvent.kt

@@ -0,0 +1,24 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE disruption ends, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param currIceCandidatePair current [IceCandidatePair]
+ * @param prevIceCandidatePair previous [IceCandidatePair]
+ * @param currIceConnectionState current ice connection state "connected" or "completed" or "checking"
+ * @param delay delay
+ */
+class IceDisruptEndEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val currIceCandidatePair: IceCandidatePair,
+    val prevIceCandidatePair: IceCandidatePair,
+    val currIceConnectionState: String,
+    val delay: Int) : IceEvent()
+{
+  val prevIceConnectionState = "disconnected"
+}

library/src/main/java/io/callstats/event/ice/IceDisruptStartEvent.kt

@@ -0,0 +1,21 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE disruption starts, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param currIceCandidatePair current [IceCandidatePair]
+ * @param prevIceConnectionState previous ice connection state "connected" or "completed"
+ */
+class IceDisruptStartEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val currIceCandidatePair: IceCandidatePair,
+    val prevIceConnectionState: String) : IceEvent()
+{
+  val eventType = "iceDisruptionStart"
+  val currIceConnectionState = "disconnected"
+}

library/src/main/java/io/callstats/event/ice/IceEvent.kt

@@ -0,0 +1,10 @@
+package io.callstats.event.ice
+
+import io.callstats.event.SessionEvent
+
+/**
+ * Base type for ICE events
+ */
+abstract class IceEvent : SessionEvent() {
+  override fun path() = "event/ice/status"
+}

library/src/main/java/io/callstats/event/ice/IceFailedEvent.kt

@@ -0,0 +1,28 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidate
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE fails, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param localIceCandidates list of local [IceCandidate]
+ * @param remoteIceCandidates list of remote [IceCandidate]
+ * @param iceCandidatePairs list of [IceCandidatePair]
+ * @param prevIceConnectionState current ice connection state "checking" or "disconnected"
+ * @param delay delay in milliseconds (example: 3.5 seconds is 3500 in milliseconds)
+ */
+class IceFailedEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val localIceCandidates: Array<IceCandidate>,
+    val remoteIceCandidates: Array<IceCandidate>,
+    val iceCandidatePairs: Array<IceCandidatePair>,
+    val prevIceConnectionState: String,
+    val delay: Int) : IceEvent()
+{
+  val eventType = "iceFailed"
+  val currIceConnectionState = "failed"
+}

library/src/main/java/io/callstats/event/ice/IceRestartEvent.kt

@@ -0,0 +1,21 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE restarts, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param prevIceCandidatePair previous [IceCandidatePair]
+ * @param prevIceConnectionState previous connection state "checking" or "connected" or "completed" or "failed" or "disconnected" or "closed"
+ */
+class IceRestartEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val prevIceCandidatePair: IceCandidatePair,
+    val prevIceConnectionState: String) : IceEvent()
+{
+  val eventType = "iceRestarted"
+  val currIceConnectionState = "new"
+}

library/src/main/java/io/callstats/event/ice/IceTerminatedEvent.kt

@@ -0,0 +1,21 @@
+package io.callstats.event.ice
+
+import io.callstats.event.info.IceCandidatePair
+
+/**
+ * When ICE Terminates, this event should be submitted
+ *
+ * @param remoteID remote user identifier
+ * @param connectionID Unique identifier of connection between two endpoints. This identifier should remain the same throughout the life-time of the connection.
+ * @param prevIceCandidatePair previous [IceCandidatePair]
+ * @param prevIceConnectionState previous ice connection state "connected" or "completed" or "failed" or "disconnected"
+ */
+class IceTerminatedEvent(
+    val remoteID: String,
+    val connectionID: String,
+    val prevIceCandidatePair: IceCandidatePair,
+    val prevIceConnectionState: String) : IceEvent()
+{
+  val eventType = "iceDisruptionStart"
+  val currIceConnectionState = "closed"
+}