From 2754b8a818a222533d81b680931509a8848db9eb Mon Sep 17 00:00:00 2001 From: Denis Biryukov Date: Fri, 29 Nov 2024 11:21:00 +0100 Subject: [PATCH] docs update --- docs/api.rst | 61 +++++++++++++++++++++++++++++++++-------- include/zenoh_commons.h | 14 ---------- splitguide.yaml | 2 ++ 3 files changed, 52 insertions(+), 25 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 92b41c189..00d3315b6 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -532,6 +532,25 @@ Functions .. doxygenfunction:: z_closure_zid_call .. doxygenfunction:: z_closure_zid +Matching +======== + +Types +----- +.. doxygenstruct:: zc_owned_matching_listener_t +.. doxygenstruct:: zc_owned_closure_matching_status_t +.. doxygenstruct:: zc_matching_status_t + +Functions +--------- + +.. doxygenfunction:: zc_matching_listener_drop +.. doxygenfunction:: zc_closure_matching_status_drop +.. doxygenfunction:: zc_closure_matching_status_loan +.. doxygenfunction:: zc_closure_matching_status_call +.. doxygenfunction:: zc_closure_matching_status + + Publication =========== @@ -556,9 +575,6 @@ Types .. doxygenstruct:: z_publisher_delete_options_t :members: -.. doxygenstruct:: zc_owned_matching_listener_t -.. doxygenstruct:: zc_owned_closure_matching_status_t - Functions --------- .. doxygenfunction:: z_put @@ -582,17 +598,10 @@ Functions .. doxygenfunction:: z_reliability_default -.. doxygenfunction:: zc_closure_matching_status_drop -.. doxygenfunction:: zc_closure_matching_status_loan -.. doxygenfunction:: zc_closure_matching_status_call -.. doxygenfunction:: zc_closure_matching_status - .. doxygenfunction:: zc_publisher_get_matching_status .. doxygenfunction:: zc_publisher_declare_matching_listener .. doxygenfunction:: zc_publisher_declare_background_matching_listener -.. doxygenfunction:: zc_publisher_matching_listener_drop - Subscription ============ @@ -719,8 +728,12 @@ Functions Query ===== + Types ----- +.. doxygenstruct:: z_owned_querier_t +.. doxygenstruct:: z_loaned_querier_t + .. doxygenstruct:: z_owned_reply_t .. doxygenstruct:: z_loaned_reply_t @@ -731,12 +744,19 @@ Types :members: .. doxygenenum:: z_query_target_t .. doxygenenum:: z_consolidation_mode_t +.. doxygenenum:: zc_reply_keyexpr_t .. doxygenstruct:: z_query_consolidation_t +.. doxygenstruct:: z_querier_options_t + :members: +.. doxygenstruct:: z_querier_get_options_t + :members: + .. doxygenstruct:: z_owned_fifo_handler_reply_t .. doxygenstruct:: z_loaned_fifo_handler_reply_t .. doxygenstruct:: z_owned_ring_handler_reply_t .. doxygenstruct:: z_loaned_ring_handler_reply_t + Functions @@ -752,6 +772,26 @@ Functions .. doxygenfunction:: z_query_consolidation_latest .. doxygenfunction:: z_query_target_default +.. doxygenfunction:: z_declare_querier +.. doxygenfunction:: z_undeclare_querier +.. doxygenfunction:: z_querier_loan +.. doxygenfunction:: z_querier_drop +.. doxygenfunction:: z_declare_background_querier +.. doxygenfunction:: z_querier_id +.. doxygenfunction:: z_querier_keyexpr +.. doxygenfunction:: z_querier_get +.. doxygenfunction:: zc_querier_get_matching_status +.. doxygenfunction:: zc_querier_declare_matching_listener +.. doxygenfunction:: zc_querier_declare_background_matching_listener + +.. doxygenfunction:: z_querier_options_default +.. doxygenfunction:: z_querier_get_options_default + +.. doxygenfunction:: z_reply_loan +.. doxygenfunction:: z_reply_is_ok +.. doxygenfunction:: z_reply_ok +.. doxygenfunction:: z_reply_err + .. doxygenfunction:: z_reply_drop .. doxygenfunction:: z_reply_clone .. doxygenfunction:: z_reply_loan @@ -870,7 +910,6 @@ Types .. doxygenstruct:: ze_loaned_querying_subscriber_t .. doxygenstruct:: ze_querying_subscriber_options_t :members: -.. doxygenenum:: zc_reply_keyexpr_t Functions --------- diff --git a/include/zenoh_commons.h b/include/zenoh_commons.h index fb7eae956..d6dfc5672 100644 --- a/include/zenoh_commons.h +++ b/include/zenoh_commons.h @@ -586,14 +586,6 @@ typedef struct z_publisher_options_t { enum zc_locality_t allowed_destination; #endif } z_publisher_options_t; -/** - * An owned Zenoh querier. - * - * Sends queries to matching queryables. - */ -typedef struct ALIGN(8) z_owned_querier_t { - uint8_t _0[72]; -} z_owned_querier_t; /** * The replies consolidation strategy to apply on replies to a `z_get()`. */ @@ -892,12 +884,6 @@ typedef struct z_put_options_t { typedef struct z_moved_querier_t { struct z_owned_querier_t _this; } z_moved_querier_t; -/** - * A loaned Zenoh queryable. - */ -typedef struct ALIGN(8) z_loaned_querier_t { - uint8_t _0[72]; -} z_loaned_querier_t; /** * Options passed to the `z_querier_get()` function. */ diff --git a/splitguide.yaml b/splitguide.yaml index f8f2fe53a..eda6949f8 100644 --- a/splitguide.yaml +++ b/splitguide.yaml @@ -35,6 +35,8 @@ zenoh_opaque.h: - z_loaned_query_t! - z_owned_queryable_t! - z_loaned_queryable_t! + - z_owned_querier_t! + - z_loaned_querier_t! - ze_owned_querying_subscriber_t!#unstable - ze_loaned_querying_subscriber_t!#unstable - z_owned_keyexpr_t!