Making Session.open(config) internal, exposing it through Zenoh.open(…

…config)
eclipse-zenoh · Sep 13, 2024 · a113cc2 · a113cc2
1 parent cc56928
commit a113cc2
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 9 deletions.
diff --git a/examples/src/main/kotlin/io.zenoh/ZDelete.kt b/examples/src/main/kotlin/io.zenoh/ZDelete.kt
@@ -25,7 +25,7 @@ class ZDelete(private val emptyArgs: Boolean) : CliktCommand(
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
         println("Opening session...")
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 key.intoKeyExpr().onSuccess { keyExpr ->
                     println("Deleting resources matching '$keyExpr'...")

diff --git a/examples/src/main/kotlin/io.zenoh/ZGet.kt b/examples/src/main/kotlin/io.zenoh/ZGet.kt
@@ -32,7 +32,7 @@ class ZGet(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 selector.intoSelector().onSuccess { selector ->
                     session.get(selector,

diff --git a/examples/src/main/kotlin/io.zenoh/ZPub.kt b/examples/src/main/kotlin/io.zenoh/ZPub.kt
@@ -26,7 +26,7 @@ class ZPub(private val emptyArgs: Boolean) : CliktCommand(
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
         println("Opening session...")
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 key.intoKeyExpr().onSuccess { keyExpr ->
                     println("Declaring publisher on '$keyExpr'...")

diff --git a/examples/src/main/kotlin/io.zenoh/ZPubThr.kt b/examples/src/main/kotlin/io.zenoh/ZPubThr.kt
@@ -45,7 +45,7 @@ class ZPubThr(private val emptyArgs: Boolean) : CliktCommand(
             priority = priorityInput?.let { Priority.entries[it] } ?: Priority.DATA,
         )
 
-        Session.open(config).onSuccess {
+        Zenoh.open(config).onSuccess {
             it.use { session ->
                 session.declarePublisher("test/thr".intoKeyExpr().getOrThrow(), qos = qos).onSuccess { pub ->
                     println("Publisher declared on test/thr.")

diff --git a/examples/src/main/kotlin/io.zenoh/ZPut.kt b/examples/src/main/kotlin/io.zenoh/ZPut.kt
@@ -27,7 +27,7 @@ class ZPut(private val emptyArgs: Boolean) : CliktCommand(
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
         println("Opening Session...")
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 key.intoKeyExpr().onSuccess { keyExpr ->
                     keyExpr.use {

diff --git a/examples/src/main/kotlin/io.zenoh/ZQueryable.kt b/examples/src/main/kotlin/io.zenoh/ZQueryable.kt
@@ -29,7 +29,7 @@ class ZQueryable(private val emptyArgs: Boolean) : CliktCommand(
     override fun run() {
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 key.intoKeyExpr().onSuccess { keyExpr ->
                     println("Declaring Queryable on $key...")

diff --git a/examples/src/main/kotlin/io.zenoh/ZSub.kt b/examples/src/main/kotlin/io.zenoh/ZSub.kt
@@ -28,7 +28,7 @@ class ZSub(private val emptyArgs: Boolean) : CliktCommand(
         val config = loadConfig(emptyArgs, configFile, connect, listen, noMulticastScouting, mode)
 
         println("Opening session...")
-        Session.open(config).onSuccess { session ->
+        Zenoh.open(config).onSuccess { session ->
             session.use {
                 key.intoKeyExpr().onSuccess { keyExpr ->
                     keyExpr.use {

diff --git a/examples/src/main/kotlin/io.zenoh/ZSubThr.kt b/examples/src/main/kotlin/io.zenoh/ZSubThr.kt
@@ -76,7 +76,7 @@ class ZSubThr(private val emptyArgs: Boolean) : CliktCommand(
         "test/thr".intoKeyExpr().onSuccess { keyExpr ->
             keyExpr.use {
                 println("Opening Session")
-                Session.open(config).onSuccess { session ->
+                Zenoh.open(config).onSuccess { session ->
                     session.use {
                         println("Press CTRL-C to quit...")
                         subscriber =

diff --git a/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Session.kt b/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Session.kt
@@ -66,10 +66,12 @@ class Session private constructor(private val config: Config) : AutoCloseable {
         /**
          * Open a [Session] with the provided [Config].
          *
+         * Note: Use [Zenoh.open] to launch a session.
+         *
          * @param config The configuration for the session.
          * @return A [Result] with the [Session] on success.
          */
-        fun open(config: Config): Result<Session> {
+        internal fun open(config: Config): Result<Session> {
             val session = Session(config)
             return session.launch()
         }

diff --git a/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Zenoh.kt b/zenoh-kotlin/src/commonMain/kotlin/io/zenoh/Zenoh.kt
@@ -26,6 +26,16 @@ import kotlinx.coroutines.channels.Channel
 
 object Zenoh {
 
+    /**
+     * Open a [Session] with the provided [Config].
+     *
+     * @param config The configuration for the session.
+     * @return A [Result] with the [Session] on success.
+     */
+    fun open(config: Config): Result<Session> {
+        return Session.open(config)
+    }
+
     /**
      * Scout for routers and/or peers.
      *