make z_close take session by mutable reference (#708)

* make z_close take session by mutable reference * Update src/api/api.c Co-authored-by: Alexander Bushnev <[email protected]> --------- Co-authored-by: Alexander Bushnev <[email protected]>
eclipse-zenoh · Oct 4, 2024 · 44fa974 · 44fa974
1 parent 2556404
commit 44fa974
Show file tree

Hide file tree

Showing 89 changed files with 201 additions and 156 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -821,6 +821,7 @@ Functions
 ^^^^^^^^^
 .. autocfunction:: primitives.h::z_open
 .. autocfunction:: primitives.h::z_close
+.. autocfunction:: primitives.h::z_session_is_closed
 
 .. autocfunction:: primitives.h::z_info_zid
 .. autocfunction:: primitives.h::z_info_routers_zid

diff --git a/examples/arduino/z_get.ino b/examples/arduino/z_get.ino
@@ -96,7 +96,7 @@ void setup() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         Serial.println("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         while (1) {
             ;
         }

diff --git a/examples/arduino/z_pub.ino b/examples/arduino/z_pub.ino
@@ -72,7 +72,7 @@ void setup() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         Serial.println("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         while (1) {
             ;
         }

diff --git a/examples/arduino/z_pull.ino b/examples/arduino/z_pull.ino
@@ -73,7 +73,7 @@ void setup() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         Serial.println("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         while (1) {
             ;
         }

diff --git a/examples/arduino/z_queryable.ino b/examples/arduino/z_queryable.ino
@@ -98,7 +98,7 @@ void setup() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         Serial.println("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         while (1) {
             ;
         }

diff --git a/examples/arduino/z_sub.ino b/examples/arduino/z_sub.ino
@@ -85,7 +85,7 @@ void setup() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         Serial.println("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         while (1) {
             ;
         }

diff --git a/examples/espidf/z_get.c b/examples/espidf/z_get.c
@@ -180,7 +180,7 @@ void app_main() {
 
     printf("Closing Zenoh Session...");
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     printf("OK!\n");
 }
 #else

diff --git a/examples/espidf/z_pub.c b/examples/espidf/z_pub.c
@@ -165,7 +165,7 @@ void app_main() {
     printf("Closing Zenoh Session...");
     z_undeclare_publisher(z_move(pub));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     printf("OK!\n");
 }
 #else

diff --git a/examples/espidf/z_pull.c b/examples/espidf/z_pull.c
@@ -140,7 +140,7 @@ void app_main() {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         exit(-1);
     }
 
@@ -181,7 +181,7 @@ void app_main() {
     z_undeclare_subscriber(z_move(sub));
     z_drop(z_move(handler));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     printf("OK!\n");
 }
 #else

diff --git a/examples/espidf/z_queryable.c b/examples/espidf/z_queryable.c
@@ -187,7 +187,7 @@ void app_main() {
     printf("Closing Zenoh Session...");
     z_undeclare_queryable(z_move(qable));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     printf("OK!\n");
 }
 #else

diff --git a/examples/espidf/z_sub.c b/examples/espidf/z_sub.c
@@ -168,7 +168,7 @@ void app_main() {
     printf("Closing Zenoh Session...");
     z_undeclare_subscriber(z_move(sub));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     printf("OK!\n");
 }
 #else

diff --git a/examples/freertos_plus_tcp/z_get.c b/examples/freertos_plus_tcp/z_get.c
@@ -71,7 +71,7 @@ void app_main(void) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -100,7 +100,7 @@ void app_main(void) {
         }
     }
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_pub.c b/examples/freertos_plus_tcp/z_pub.c
@@ -78,7 +78,7 @@ void app_main(void) {
     if (zp_start_read_task(z_loan_mut(s), &read_task_opt) < 0 ||
         zp_start_lease_task(z_loan_mut(s), &lease_task_opt) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -108,7 +108,7 @@ void app_main(void) {
 
     // Clean-up
     z_undeclare_publisher(z_move(pub));
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_pub_st.c b/examples/freertos_plus_tcp/z_pub_st.c
@@ -80,7 +80,7 @@ void app_main(void) {
 
     z_undeclare_publisher(z_move(pub));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_pull.c b/examples/freertos_plus_tcp/z_pull.c
@@ -49,7 +49,7 @@ void app_main(void) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -90,7 +90,7 @@ void app_main(void) {
     z_undeclare_subscriber(z_move(sub));
     z_drop(z_move(handler));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_put.c b/examples/freertos_plus_tcp/z_put.c
@@ -47,7 +47,7 @@ void app_main(void) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -57,7 +57,7 @@ void app_main(void) {
     z_view_keyexpr_from_str_unchecked(&vke, KEYEXPR);
     if (z_declare_keyexpr(&ke, z_loan(s), z_loan(vke)) < 0) {
         printf("Unable to declare key expression!\n");
-        z_close(z_move(s), NULL);
+        z_drop(z_move(s));
         return;
     }
 
@@ -79,7 +79,7 @@ void app_main(void) {
 
     // Clean up
     z_undeclare_keyexpr(z_move(ke), z_loan(s));
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_queryable.c b/examples/freertos_plus_tcp/z_queryable.c
@@ -73,7 +73,7 @@ void app_main(void) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -98,7 +98,7 @@ void app_main(void) {
 
     z_undeclare_queryable(z_move(qable));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_sub.c b/examples/freertos_plus_tcp/z_sub.c
@@ -57,7 +57,7 @@ void app_main(void) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return;
     }
 
@@ -78,7 +78,7 @@ void app_main(void) {
 
     z_undeclare_subscriber(z_move(sub));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/freertos_plus_tcp/z_sub_st.c b/examples/freertos_plus_tcp/z_sub_st.c
@@ -78,7 +78,7 @@ void app_main(void) {
 
     z_undeclare_subscriber(z_move(sub));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
 #else
 void app_main(void) {

diff --git a/examples/mbed/z_get.cpp b/examples/mbed/z_get.cpp
@@ -101,7 +101,7 @@ int main(int argc, char **argv) {
 
     printf("Closing Zenoh Session...");
 
-    z_close(z_session_move(&s), NULL);
+    z_session_drop(z_session_move(&s));
     printf("OK!\n");
 
     return 0;

diff --git a/examples/mbed/z_pub.cpp b/examples/mbed/z_pub.cpp
@@ -85,7 +85,7 @@ int main(int argc, char **argv) {
     printf("Closing Zenoh Session...");
     z_undeclare_publisher(z_publisher_move(&pub));
 
-    z_close(z_session_move(&s), NULL);
+    z_session_drop(z_session_move(&s));
     printf("OK!\n");
 
     return 0;

diff --git a/examples/mbed/z_pull.cpp b/examples/mbed/z_pull.cpp
@@ -60,7 +60,7 @@ int main(int argc, char **argv) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_session_loan_mut(&s), NULL) < 0 || zp_start_lease_task(z_session_loan_mut(&s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return -1;
     }
 
@@ -104,7 +104,7 @@ int main(int argc, char **argv) {
     z_undeclare_subscriber(z_subscriber_move(&sub));
     z_ring_handler_sample_drop(z_ring_handler_sample_move(&handler));
 
-    z_close(z_session_move(&s), NULL);
+    z_session_drop(z_session_move(&s));
     printf("OK!\n");
 
     return 0;

diff --git a/examples/mbed/z_queryable.cpp b/examples/mbed/z_queryable.cpp
@@ -106,7 +106,7 @@ int main(int argc, char **argv) {
     printf("Closing Zenoh Session...");
     z_undeclare_queryable(z_queryable_move(&qable));
 
-    z_close(z_session_move(&s), NULL);
+    z_session_drop(z_session_move(&s));
     printf("OK!\n");
 
     return 0;

diff --git a/examples/mbed/z_sub.cpp b/examples/mbed/z_sub.cpp
@@ -89,7 +89,7 @@ int main(int argc, char **argv) {
     printf("Closing Zenoh Session...");
     z_undeclare_subscriber(z_subscriber_move(&sub));
 
-    z_close(z_session_move(&s), NULL);
+    z_session_drop(z_session_move(&s));
     printf("OK!\n");
 
     return 0;

diff --git a/examples/unix/c11/z_get.c b/examples/unix/c11/z_get.c
@@ -113,7 +113,7 @@ int main(int argc, char **argv) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return -1;
     }
 
@@ -143,7 +143,7 @@ int main(int argc, char **argv) {
     z_condvar_wait(z_loan_mut(cond), z_loan_mut(mutex));
     z_mutex_unlock(z_loan_mut(mutex));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     return 0;
 }
 

diff --git a/examples/unix/c11/z_get_attachment.c b/examples/unix/c11/z_get_attachment.c
@@ -149,7 +149,7 @@ int main(int argc, char **argv) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return -1;
     }
 
@@ -201,7 +201,7 @@ int main(int argc, char **argv) {
     z_condvar_wait(z_loan_mut(cond), z_loan_mut(mutex));
     z_mutex_unlock(z_loan_mut(mutex));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
     return 0;
 }
 #else

diff --git a/examples/unix/c11/z_get_channel.c b/examples/unix/c11/z_get_channel.c
@@ -77,7 +77,7 @@ int main(int argc, char **argv) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return -1;
     }
 
@@ -123,7 +123,7 @@ int main(int argc, char **argv) {
 
     z_drop(z_move(handler));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 
     return 0;
 }

diff --git a/examples/unix/c11/z_info.c b/examples/unix/c11/z_info.c
@@ -76,7 +76,7 @@ int main(int argc, char **argv) {
     // Start read and lease tasks for zenoh-pico
     if (zp_start_read_task(z_loan_mut(s), NULL) < 0 || zp_start_lease_task(z_loan_mut(s), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&s), NULL);
+        z_session_drop(z_session_move(&s));
         return -1;
     }
 
@@ -96,5 +96,5 @@ int main(int argc, char **argv) {
     z_closure(&callback2, print_zid);
     z_info_peers_zid(z_loan(s), z_move(callback2));
 
-    z_close(z_move(s), NULL);
+    z_drop(z_move(s));
 }
diff --git a/examples/unix/c11/z_ping.c b/examples/unix/c11/z_ping.c
@@ -73,7 +73,7 @@ int main(int argc, char** argv) {
 
     if (zp_start_read_task(z_loan_mut(session), NULL) < 0 || zp_start_lease_task(z_loan_mut(session), NULL) < 0) {
         printf("Unable to start read and lease tasks\n");
-        z_close(z_session_move(&session), NULL);
+        z_drop(z_move(session));
         return -1;
     }
 
@@ -135,7 +135,7 @@ int main(int argc, char** argv) {
     z_drop(z_move(pub));
     z_drop(z_move(sub));
 
-    z_close(z_move(session), NULL);
+    z_drop(z_move(session));
 }
 
 char* getopt(int argc, char** argv, char option) {