From 4d3fa04e6e1579a9bc49398a1155eb9ea707ec74 Mon Sep 17 00:00:00 2001 From: Alexander Bushnev Date: Tue, 1 Oct 2024 15:01:49 +0200 Subject: [PATCH] Restore rebase missed changes --- docs/api.rst | 1048 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 635 insertions(+), 413 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index ba9d3ef65..2171790b9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ .. -.. Copyright (c) 2022 ZettaScale Technology +.. Copyright (c) 2024 ZettaScale Technology .. .. This program and the accompanying materials are made available under the .. terms of the Eclipse Public License 2.0 which is available at @@ -16,283 +16,759 @@ API Reference ************* -Zenoh Types ------------ +Containers +============= -Enums -~~~~~ +Slice +----- + +Represents an array of bytes. -.. autocenum:: constants.h::z_whatami_t -.. autocenum:: constants.h::zp_keyexpr_canon_status_t -.. autocenum:: constants.h::z_sample_kind_t -.. autocenum:: constants.h::z_consolidation_mode_t -.. autocenum:: constants.h::z_reliability_t -.. autocenum:: constants.h::z_congestion_control_t -.. autocenum:: constants.h::z_priority_t -.. autocenum:: constants.h::z_query_target_t +Types +^^^^^ +.. c:type:: z_owned_slice_t +.. c:type:: z_view_slice_t +.. c:type:: z_loaned_slice_t +.. c:type:: z_moved_slice_t -Data Structures -~~~~~~~~~~~~~~~ -.. autoctype:: types.h::z_zint_t -.. autoctype:: types.h::z_id_t -.. autoctype:: types.h::z_timestamp_t -.. autoctype:: types.h::z_subscriber_options_t -.. autoctype:: types.h::z_query_consolidation_t -.. autoctype:: types.h::z_publisher_options_t -.. autoctype:: types.h::z_queryable_options_t -.. autoctype:: types.h::z_query_reply_options_t -.. autoctype:: types.h::z_put_options_t -.. autoctype:: types.h::z_delete_options_t -.. autoctype:: types.h::z_publisher_put_options_t -.. autoctype:: types.h::z_publisher_delete_options_t -.. autoctype:: types.h::z_get_options_t -.. autoctype:: types.h::zp_task_read_options_t -.. autoctype:: types.h::zp_task_lease_options_t -.. autoctype:: types.h::zp_read_options_t -.. autoctype:: types.h::zp_send_keep_alive_options_t -.. autoctype:: types.h::zp_send_join_options_t -.. autoctype:: types.h::z_bytes_reader_t -.. autoctype:: types.h::z_bytes_slice_iterator_t -.. autoctype:: serialization.h::ze_deserializer_t - +Functions +^^^^^^^^^ -Owned Types -~~~~~~~~~~~ +.. c:function:: const z_loaned_slice_t * z_view_slice_loan(const struct z_view_slice_t * slice) +.. c:function:: const z_loaned_slice_t * z_slice_loan(const struct z_owned_slice_t * slice) +.. c:function:: void z_slice_drop(struct z_moved_slice_t * slice) +.. c:function:: void z_slice_clone(struct z_owned_slice_t * dst, const struct z_loaned_slice_t * slice) -See :ref:`owned_types_concept` + See :ref:`owned_types_concept` + +.. autocfunction:: primitives.h::z_slice_empty +.. autocfunction:: primitives.h::z_slice_copy_from_buf +.. autocfunction:: primitives.h::z_slice_from_buf +.. autocfunction:: primitives.h::z_slice_data +.. autocfunction:: primitives.h::z_slice_len +.. autocfunction:: primitives.h::z_slice_is_empty + +.. autocfunction:: primitives.h::z_view_slice_from_buf +.. c:function:: void z_view_slice_empty(z_view_slice_t * slice) + + See :c:func:`z_slice_empty` -.. c:type:: z_owned_slice_t - - Represents an array of bytes. -.. c:type:: z_owned_bytes_t +String +------ - Represents an array of bytes container. +Represents a string without null-terminator. -.. c:type:: z_owned_bytes_writer_t +Types +^^^^^ +.. c:type:: z_owned_string_t +.. c:type:: z_view_string_t +.. c:type:: z_loaned_string_t +.. c:type:: z_moved_string_t - Represents a payload writer. +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: primitives.h::z_string_loan +.. TODO .. autocfunction:: primitives.h::z_view_string_loan +.. TODO .. autocfunction:: primitives.h::z_string_drop +.. TODO .. autocfunction:: primitives.h::z_string_clone -.. c:type:: ze_owned_serializer_t +.. autocfunction:: primitives.h::z_string_empty +.. autocfunction:: primitives.h::z_string_copy_from_str +.. autocfunction:: primitives.h::z_string_copy_from_substr +.. autocfunction:: primitives.h::z_string_from_str +.. autocfunction:: primitives.h::z_string_data +.. autocfunction:: primitives.h::z_string_len +.. autocfunction:: primitives.h::z_string_is_empty - Represents a data serializer (unstable). +.. autocfunction:: primitives.h::z_view_string_from_str +.. autocfunction:: primitives.h::z_view_string_from_substr +.. c:function:: void z_view_string_empty(z_view_string_t * string) -.. c:type:: z_owned_string_t + See :c:func:`z_string_empty` - Represents a string without null-terminator. -.. c:type:: z_owned_keyexpr_t - Represents a key expression in Zenoh. -.. c:type:: z_owned_config_t +String Array +------------ - Represents a Zenoh configuration, used to configure Zenoh sessions upon opening. +Represents an array of non null-terminated string. -.. c:type:: z_owned_session_t +Types +^^^^^ +.. c:type:: z_owned_string_array_t +.. c:type:: z_loaned_string_array_t +.. c:type:: z_moved_string_array_t - Represents a Zenoh Session. +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: primitives.h::z_string_array_loan +.. TODO .. autocfunction:: primitives.h::z_string_array_loan_mut +.. TODO .. autocfunction:: primitives.h::z_string_array_clone +.. TODO .. autocfunction:: primitives.h::z_string_array_drop -.. c:type:: z_owned_subscriber_t +.. autocfunction:: primitives.h::z_string_array_new +.. autocfunction:: primitives.h::z_string_array_push_by_alias +.. autocfunction:: primitives.h::z_string_array_push_by_copy +.. autocfunction:: primitives.h::z_string_array_get +.. autocfunction:: primitives.h::z_string_array_len +.. autocfunction:: primitives.h::z_string_array_is_empty - Represents a Zenoh Subscriber entity. +Common +====== -.. c:type:: z_owned_publisher_t +Key expression +-------------- - Represents a Zenoh Publisher entity. +Represents a key expression in Zenoh. -.. c:type:: z_owned_queryable_t +Types +^^^^^ +.. c:type:: z_owned_keyexpr_t +.. c:type:: z_view_keyexpr_t +.. c:type:: z_loaned_keyexpr_t +.. c:type:: z_moved_keyexpr_t +.. autocenum:: constants.h::z_keyexpr_intersection_level_t +.. autocenum:: constants.h::z_whatami_t +.. autocenum:: constants.h::zp_keyexpr_canon_status_t - Represents a Zenoh Queryable entity. +Functions +^^^^^^^^^ +.. autocfunction:: primitives.h::z_keyexpr_from_str +.. autocfunction:: primitives.h::z_view_keyexpr_from_str +.. autocfunction:: primitives.h::z_keyexpr_from_str_autocanonize +.. autocfunction:: primitives.h::z_view_keyexpr_from_str_autocanonize +.. autocfunction:: primitives.h::z_view_keyexpr_from_str_unchecked -.. c:type:: z_owned_query_t +.. autocfunction:: primitives.h::z_keyexpr_from_substr +.. autocfunction:: primitives.h::z_view_keyexpr_from_substr +.. autocfunction:: primitives.h::z_keyexpr_from_substr_autocanonize +.. autocfunction:: primitives.h::z_view_keyexpr_from_substr_autocanonize +.. autocfunction:: primitives.h::z_view_keyexpr_from_substr_unchecked - Represents a Zenoh Query entity, received by Zenoh queryable entities. +.. TODO .. autocfunction:: primitives.h::z_keyexpr_loan +.. TODO .. autocfunction:: primitives.h::z_view_keyexpr_loan +.. TODO .. autocfunction:: primitives.h::z_keyexpr_clone +.. TODO .. autocfunction:: primitives.h::z_keyexpr_drop + +.. autocfunction:: primitives.h::z_keyexpr_as_view_string + +.. autocfunction:: primitives.h::z_keyexpr_canonize +.. autocfunction:: primitives.h::z_keyexpr_canonize_null_terminated +.. autocfunction:: primitives.h::z_keyexpr_is_canon + +.. autocfunction:: primitives.h::z_keyexpr_concat +.. autocfunction:: primitives.h::z_keyexpr_join +.. autocfunction:: primitives.h::z_keyexpr_equals +.. autocfunction:: primitives.h::z_keyexpr_includes +.. autocfunction:: primitives.h::z_keyexpr_intersects +.. autocfunction:: primitives.h::z_declare_keyexpr +.. autocfunction:: primitives.h::z_undeclare_keyexpr + +Encoding +-------- +Types +^^^^^ .. c:type:: z_owned_encoding_t +.. c:type:: z_loaned_encoding_t +.. c:type:: z_moved_encoding_t Represents the encoding of a payload, in a MIME-like format. +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: encoding.h::z_encoding_loan +.. TODO .. autocfunction:: encoding.h::z_encoding_loan_mut +.. TODO .. autocfunction:: encoding.h::z_encoding_drop +.. TODO (add method) .. autocfunction:: encoding.h::z_encoding_loan_default + +.. autocfunction:: primitives.h::z_encoding_from_str +.. autocfunction:: primitives.h::z_encoding_from_substr +.. autocfunction:: primitives.h::z_encoding_set_schema_from_str +.. autocfunction:: primitives.h::z_encoding_set_schema_from_substr +.. autocfunction:: primitives.h::z_encoding_to_string +.. autocfunction:: primitives.h::z_encoding_equals + +Predefined Encodings +^^^^^^^^^^^^^^^^^^^^ +.. autocfunction:: encoding.h::z_encoding_zenoh_bytes +.. autocfunction:: encoding.h::z_encoding_zenoh_int8 +.. autocfunction:: encoding.h::z_encoding_zenoh_int16 +.. autocfunction:: encoding.h::z_encoding_zenoh_int32 +.. autocfunction:: encoding.h::z_encoding_zenoh_int64 +.. autocfunction:: encoding.h::z_encoding_zenoh_int128 +.. autocfunction:: encoding.h::z_encoding_zenoh_uint8 +.. autocfunction:: encoding.h::z_encoding_zenoh_uint16 +.. autocfunction:: encoding.h::z_encoding_zenoh_uint32 +.. autocfunction:: encoding.h::z_encoding_zenoh_uint64 +.. autocfunction:: encoding.h::z_encoding_zenoh_uint128 +.. autocfunction:: encoding.h::z_encoding_zenoh_float32 +.. autocfunction:: encoding.h::z_encoding_zenoh_float64 +.. autocfunction:: encoding.h::z_encoding_zenoh_bool +.. autocfunction:: encoding.h::z_encoding_zenoh_string +.. autocfunction:: encoding.h::z_encoding_zenoh_error +.. autocfunction:: encoding.h::z_encoding_application_octet_stream +.. autocfunction:: encoding.h::z_encoding_text_plain +.. autocfunction:: encoding.h::z_encoding_application_json +.. autocfunction:: encoding.h::z_encoding_text_json +.. autocfunction:: encoding.h::z_encoding_application_cdr +.. autocfunction:: encoding.h::z_encoding_application_cbor +.. autocfunction:: encoding.h::z_encoding_application_yaml +.. autocfunction:: encoding.h::z_encoding_text_yaml +.. autocfunction:: encoding.h::z_encoding_text_json5 +.. autocfunction:: encoding.h::z_encoding_application_python_serialized_object +.. autocfunction:: encoding.h::z_encoding_application_protobuf +.. autocfunction:: encoding.h::z_encoding_application_java_serialized_object +.. autocfunction:: encoding.h::z_encoding_application_openmetrics_text +.. autocfunction:: encoding.h::z_encoding_image_png +.. autocfunction:: encoding.h::z_encoding_image_jpeg +.. autocfunction:: encoding.h::z_encoding_image_gif +.. autocfunction:: encoding.h::z_encoding_image_bmp +.. autocfunction:: encoding.h::z_encoding_image_webp +.. autocfunction:: encoding.h::z_encoding_application_xml +.. autocfunction:: encoding.h::z_encoding_application_x_www_form_urlencoded +.. autocfunction:: encoding.h::z_encoding_text_html +.. autocfunction:: encoding.h::z_encoding_text_xml +.. autocfunction:: encoding.h::z_encoding_text_css +.. autocfunction:: encoding.h::z_encoding_text_javascript +.. autocfunction:: encoding.h::z_encoding_text_markdown +.. autocfunction:: encoding.h::z_encoding_text_csv +.. autocfunction:: encoding.h::z_encoding_application_sql +.. autocfunction:: encoding.h::z_encoding_application_coap_payload +.. autocfunction:: encoding.h::z_encoding_application_json_patch_json +.. autocfunction:: encoding.h::z_encoding_application_json_seq +.. autocfunction:: encoding.h::z_encoding_application_jsonpath +.. autocfunction:: encoding.h::z_encoding_application_jwt +.. autocfunction:: encoding.h::z_encoding_application_mp4 +.. autocfunction:: encoding.h::z_encoding_application_soap_xml +.. autocfunction:: encoding.h::z_encoding_application_yang +.. autocfunction:: encoding.h::z_encoding_audio_aac +.. autocfunction:: encoding.h::z_encoding_audio_flac +.. autocfunction:: encoding.h::z_encoding_audio_mp4 +.. autocfunction:: encoding.h::z_encoding_audio_ogg +.. autocfunction:: encoding.h::z_encoding_audio_vorbis +.. autocfunction:: encoding.h::z_encoding_video_h261 +.. autocfunction:: encoding.h::z_encoding_video_h263 +.. autocfunction:: encoding.h::z_encoding_video_h264 +.. autocfunction:: encoding.h::z_encoding_video_h265 +.. autocfunction:: encoding.h::z_encoding_video_h266 +.. autocfunction:: encoding.h::z_encoding_video_mp4 +.. autocfunction:: encoding.h::z_encoding_video_ogg +.. autocfunction:: encoding.h::z_encoding_video_raw +.. autocfunction:: encoding.h::z_encoding_video_vp8 +.. autocfunction:: encoding.h::z_encoding_video_vp9 + +Reply Error +----------- +Types +^^^^^ .. c:type:: z_owned_reply_err_t +.. c:type:: z_loaned_reply_err_t Represents a Zenoh reply error value. +Functions +^^^^^^^^^ +.. autocfunction:: primitives.h::z_reply_err_payload +.. autocfunction:: primitives.h::z_reply_err_encoding + +.. TODO .. autocfunction:: primitives.h::z_reply_err_loan +.. TODO .. autocfunction:: primitives.h::z_reply_err_clone +.. TODO .. autocfunction:: primitives.h::z_reply_err_drop + +Sample +------ +Types +^^^^^ .. c:type:: z_owned_sample_t +.. c:type:: z_loaned_sample_t +.. c:type:: z_moved_sample_t Represents a data sample. -.. c:type:: z_owned_hello_t +.. autocenum:: constants.h::z_sample_kind_t - Represents the content of a `hello` message returned by a zenoh entity as a reply to a `scout` message. +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: primitives.h::z_sample_loan +.. TODO .. autocfunction:: primitives.h::z_sample_drop -.. c:type:: z_owned_reply_t +.. autocfunction:: primitives.h::z_sample_timestamp +.. autocfunction:: primitives.h::z_sample_attachment +.. autocfunction:: primitives.h::z_sample_encoding +.. autocfunction:: primitives.h::z_sample_payload +.. autocfunction:: primitives.h::z_sample_keyexpr +.. autocfunction:: primitives.h::z_sample_priority +.. autocfunction:: primitives.h::z_sample_congestion_control +.. autocfunction:: primitives.h::z_sample_express +.. autocfunction:: primitives.h::z_sample_reliability - Represents the reply to a query. -.. c:type:: z_owned_string_array_t +Timestamp +--------- +Types +^^^^^ +.. c:type:: z_timestamp_t + +Functions +^^^^^^^^^ +.. autocfunction:: primitives.h::z_timestamp_id +.. autocfunction:: primitives.h::z_timestamp_ntp64_time + +System +====== +Random +------ +Functions +^^^^^^^^^ +.. autocfunction:: platform_common.h::z_random_u8 +.. autocfunction:: platform_common.h::z_random_u16 +.. autocfunction:: platform_common.h::z_random_u32 +.. autocfunction:: platform_common.h::z_random_u64 +.. autocfunction:: platform_common.h::z_random_fill + +Sleep +------ +Functions +^^^^^^^^^ +.. autocfunction:: platform_common.h::z_sleep_s +.. autocfunction:: platform_common.h::z_sleep_ms +.. autocfunction:: platform_common.h::z_sleep_us + +Time +---- + +Types +^^^^^ +.. c:type:: z_clock_t +.. c:type:: z_time_t + +Functions +^^^^^^^^^ +.. autocfunction:: platform_common.h::z_clock_now +.. autocfunction:: platform_common.h::z_clock_elapsed_s +.. autocfunction:: platform_common.h::z_clock_elapsed_ms +.. autocfunction:: platform_common.h::z_clock_elapsed_us + +.. autocfunction:: platform_common.h::z_time_now +.. autocfunction:: platform_common.h::z_time_elapsed_s +.. autocfunction:: platform_common.h::z_time_elapsed_ms +.. autocfunction:: platform_common.h::z_time_elapsed_us +.. autocfunction:: platform_common.h::z_time_now_as_str + + +Mutex +----- +Types +^^^^^ +.. c:type:: z_owned_mutex_t +.. c:type:: z_loaned_mutex_t +.. c:type:: z_moved_mutex_t + +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: platform_common.h::z_mutex_loan_mut +.. autocfunction:: platform_common.h::z_mutex_drop + +.. TODO .. autocfunction:: platform_common.h::z_mutex_init +.. autocfunction:: platform_common.h::z_mutex_lock +.. autocfunction:: platform_common.h::z_mutex_unlock +.. autocfunction:: platform_common.h::z_mutex_try_lock + + +Conditional Variable +-------------------- +Types +^^^^^ +.. c:type:: z_owned_condvar_t +.. c:type:: z_loaned_condvar_t +.. c:type:: z_moved_condvar_t + +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: platform_common.h::z_condvar_loan +.. TODO .. autocfunction:: platform_common.h::z_condvar_drop + +.. TODO .. autocfunction:: platform_common.h::z_condvar_init +.. autocfunction:: platform_common.h::z_condvar_wait +.. autocfunction:: platform_common.h::z_condvar_signal + + +Task +---- +Types +^^^^^ +.. c:type:: z_owned_task_t +.. c:type:: z_loaned_task_t +.. c:type:: z_moved_task_t + +Functions +^^^^^^^^^ +.. autocfunction:: platform_common.h::z_task_join +.. TODO .. autocfunction:: platform_common.h::z_task_detach + +Session +======= + +Session configuration +--------------------- + +Represents a Zenoh configuration, used to configure Zenoh sessions upon opening. + +Types +^^^^^ +.. c:type:: z_owned_config_t +.. c:type:: z_loaned_config_t +.. c:type:: z_moved_config_t - Represents an array of non null-terminated string. +Functions +^^^^^^^^^ +.. TODO .. autocfunction:: primitives.h::z_config_loan +.. TODO .. autocfunction:: primitives.h::z_config_loan_mut +.. TODO .. autocfunction:: primitives.h::z_config_drop + +.. autocfunction:: primitives.h::z_config_new +.. autocfunction:: primitives.h::z_config_default +.. autocfunction:: primitives.h::zp_config_get +.. autocfunction:: primitives.h::zp_config_insert -Loaned Types -~~~~~~~~~~~ +Session management +------------------ -See :ref:`loaned_types_concept` +Represents a Zenoh Session. -.. c:type:: z_loaned_slice_t +Types +^^^^^ +.. c:type:: z_owned_session_t +.. c:type:: z_loaned_session_t +.. c:type:: z_moved_session_t +.. c:type:: z_id_t - Represents an array of bytes. +.. c:type:: z_owned_closure_zid_t -.. c:type:: z_loaned_bytes_t +Functions +^^^^^^^^^ +.. autocfunction:: primitives.h::z_open +.. autocfunction:: primitives.h::z_close - Represents an array of bytes container. +.. TODO .. autocfunction:: primitives.h::z_session_loan +.. TODO .. autocfunction:: primitives.h::z_session_drop -.. c:type:: z_loaned_bytes_writer_t +.. autocfunction:: primitives.h::z_info_zid +.. autocfunction:: primitives.h::z_info_routers_zid +.. autocfunction:: primitives.h::z_info_peers_zid +.. autocfunction:: primitives.h::z_id_to_string - Represents a payload writer. +.. TODO .. autocfunction:: primitives.h::z_closure_zid_drop +.. TODO .. autocfunction:: primitives.h::z_closure_zid_loan +.. TODO .. autocfunction:: primitives.h::z_closure_zid_call +.. autocfunction:: primitives.h::z_closure_zid -.. c:type:: ze_loaned_serializer_t +Publication +=========== - Represents a data serializer (unstable). +Types +----- -.. c:type:: z_loaned_string_t +.. c:type:: z_owned_publisher_t +.. c:type:: z_loaned_publisher_t +.. c:type:: z_moved_publisher_t - Represents a string without null-terminator. + Represents a Zenoh Publisher entity. -.. c:type:: z_loaned_keyexpr_t +.. autocenum:: constants.h::z_congestion_control_t +.. autocenum:: constants.h::z_priority_t +.. autocenum:: constants.h::z_reliability_t - Represents a key expression in Zenoh. +.. autoctype:: types.h::z_put_options_t +.. autoctype:: types.h::z_delete_options_t +.. autoctype:: types.h::z_publisher_options_t +.. autoctype:: types.h::z_publisher_put_options_t +.. autoctype:: types.h::z_publisher_delete_options_t -.. c:type:: z_loaned_config_t +Functions +--------- +.. autocfunction:: primitives.h::z_put +.. autocfunction:: primitives.h::z_delete + +.. autocfunction:: primitives.h::z_declare_publisher +.. autocfunction:: primitives.h::z_publisher_put +.. autocfunction:: primitives.h::z_publisher_delete +.. autocfunction:: primitives.h::z_undeclare_publisher +.. autocfunction:: primitives.h::z_publisher_keyexpr - Represents a Zenoh configuration, used to configure Zenoh sessions upon opening. +.. TODO .. autocfunction:: primitives.h::z_publisher_loan +.. TODO .. autocfunction:: primitives.h::z_publisher_drop -.. c:type:: z_loaned_session_t +.. autocfunction:: primitives.h::z_put_options_default +.. autocfunction:: primitives.h::z_delete_options_default +.. autocfunction:: primitives.h::z_publisher_options_default +.. autocfunction:: primitives.h::z_publisher_put_options_default +.. autocfunction:: primitives.h::z_publisher_delete_options_default + +.. TODO (add method) .. autocfunction:: primitives.h::z_reliability_default - Represents a Zenoh Session. +Subscription +============ +Types +----- +.. c:type:: z_owned_subscriber_t .. c:type:: z_loaned_subscriber_t +.. c:type:: z_moved_subscriber_t Represents a Zenoh Subscriber entity. -.. c:type:: z_loaned_publisher_t +.. c:type:: z_owned_closure_sample_t - Represents a Zenoh Publisher entity. +.. autoctype:: types.h::z_subscriber_options_t -.. c:type:: z_loaned_queryable_t +.. c:type:: z_owned_fifo_handler_sample_t +.. c:type:: z_loaned_fifo_handler_sample_t +.. c:type:: z_owned_ring_handler_sample_t +.. c:type:: z_loaned_ring_handler_sample_t - Represents a Zenoh Queryable entity. - -.. c:type:: z_loaned_query_t +Functions +--------- - Represents a Zenoh Query entity, received by Zenoh queryable entities. +.. autocfunction:: primitives.h::z_declare_subscriber +.. autocfunction:: primitives.h::z_undeclare_subscriber -.. c:type:: z_loaned_encoding_t +.. TODO .. autocfunction:: primitives.h::z_subscriber_drop - Represents the encoding of a payload, in a MIME-like format. +.. TODO .. autocfunction:: primitives.h::z_closure_sample_call +.. TODO .. autocfunction:: primitives.h::z_closure_sample_loan +.. TODO .. autocfunction:: primitives.h::z_closure_sample_drop +.. autocfunction:: primitives.h::z_closure_sample -.. c:type:: z_loaned_reply_err_t +.. autocfunction:: primitives.h::z_subscriber_options_default - Represents a Zenoh reply error. +.. TODO .. autocfunction:: primitives.h::z_fifo_channel_sample_new +.. TODO .. autocfunction:: primitives.h::z_ring_channel_sample_new -.. c:type:: z_loaned_sample_t +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_sample_drop +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_sample_loan +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_sample_recv +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_sample_try_recv - Represents a data sample. +.. TODO .. autocfunction:: primitives.h::z_ring_handler_sample_drop +.. TODO .. autocfunction:: primitives.h::z_ring_handler_sample_loan +.. TODO .. autocfunction:: primitives.h::z_ring_handler_sample_recv +.. TODO .. autocfunction:: primitives.h::z_ring_handler_sample_try_recv -.. c:type:: z_loaned_hello_t +Queryable +========= - Represents the content of a `hello` message returned by a zenoh entity as a reply to a `scout` message. +Types +----- -.. c:type:: z_loaned_reply_t +.. c:type:: z_owned_queryable_t - Represents the reply to a query. + Represents a Zenoh Queryable entity. -.. c:type:: z_loaned_string_array_t +.. c:type:: z_owned_query_t +.. c:type:: z_loaned_query_t +.. c:type:: z_moved_query_t - Represents an array of non null-terminated string. + Represents a Zenoh Query entity, received by Zenoh queryable entities. -View Types -~~~~~~~~~~~ +.. c:type:: z_owned_closure_query_t -See :ref:`view_types_concept` +.. c:type:: z_queryable_options_t +.. c:type:: z_query_reply_options_t +.. c:type:: z_query_reply_err_options_t -.. c:type:: z_view_string_t +.. c:type:: z_owned_fifo_handler_query_t +.. c:type:: z_loaned_fifo_handler_query_t +.. c:type:: z_owned_ring_handler_query_t +.. c:type:: z_loaned_ring_handler_query_t - Represents a string without null-terminator. +Functions +--------- +.. autocfunction:: primitives.h::z_declare_queryable +.. autocfunction:: primitives.h::z_undeclare_queryable -.. c:type:: z_view_slice_t +.. autocfunction:: primitives.h::z_queryable_options_default +.. autocfunction:: primitives.h::z_query_reply_options_default +.. autocfunction:: primitives.h::z_query_reply_err_options_default - Represents an array of bytes. +.. TODO .. autocfunction:: primitives.h::z_queryable_loan +.. TODO .. autocfunction:: primitives.h::z_queryable_drop -.. c:type:: z_view_keyexpr_t +.. TODO .. autocfunction:: primitives.h::z_query_loan +.. TODO .. autocfunction:: primitives.h::z_query_drop +.. TODO .. autocfunction:: primitives.h::z_query_clone - Represents a key expression in Zenoh. +.. autocfunction:: primitives.h::z_query_keyexpr +.. autocfunction:: primitives.h::z_query_parameters +.. autocfunction:: primitives.h::z_query_payload +.. autocfunction:: primitives.h::z_query_encoding +.. autocfunction:: primitives.h::z_query_attachment +.. autocfunction:: primitives.h::z_query_reply +.. autocfunction:: primitives.h::z_query_reply_err -.. c:type:: z_view_string_array_t +.. TODO .. autocfunction:: primitives.h::z_closure_query_call +.. TODO .. autocfunction:: primitives.h::z_closure_query_loan +.. TODO .. autocfunction:: primitives.h::z_closure_query_drop +.. autocfunction:: primitives.h::z_closure_query - Represents an array of non null-terminated string. +.. TODO .. autocfunction:: primitives.h::z_fifo_channel_query_new +.. TODO .. autocfunction:: primitives.h::z_ring_channel_query_new -Closures -~~~~~~~~ +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_query_drop +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_query_loan +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_query_recv +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_query_try_recv -A closure is a structure that contains all the elements for stateful, memory-leak-free callbacks: - - context: a pointer to an arbitrary state. - - call: the typical callback function. ``context`` will be passed as its last argument. - - drop: allows the callback's state to be freed. ``context`` will be passed as its last argument. +.. TODO .. autocfunction:: primitives.h::z_ring_handler_query_drop +.. TODO .. autocfunction:: primitives.h::z_ring_handler_query_loan +.. TODO .. autocfunction:: primitives.h::z_ring_handler_query_recv +.. TODO .. autocfunction:: primitives.h::z_ring_handler_query_try_recv -Closures are not guaranteed not to be called concurrently. +Query +===== +Types +----- +.. c:type:: z_owned_reply_t +.. c:type:: z_loaned_reply_t +.. c:type:: z_moved_reply_t + + Represents the reply to a query. -It is guaranteed that: - - ``call`` will never be called once ``drop`` has started. - - ``drop`` will only be called **once**, and **after every** ``call`` has ended. - - The two previous guarantees imply that ``call`` and ``drop`` are never called concurrently. +.. c:type:: z_owned_closure_reply_t + +.. autoctype:: types.h::z_get_options_t +.. autocenum:: constants.h::z_query_target_t +.. autocenum:: constants.h::z_consolidation_mode_t +.. autoctype:: types.h::z_query_consolidation_t + +.. c:type:: z_owned_fifo_handler_reply_t +.. c:type:: z_loaned_fifo_handler_reply_t +.. c:type:: z_owned_ring_handler_reply_t +.. c:type:: z_loaned_ring_handler_reply_t + + +Functions +--------- + +.. autocfunction:: primitives.h::z_get +.. autocfunction:: primitives.h::z_get_options_default + +.. autocfunction:: primitives.h::z_query_consolidation_default +.. autocfunction:: primitives.h::z_query_consolidation_auto +.. autocfunction:: primitives.h::z_query_consolidation_none +.. autocfunction:: primitives.h::z_query_consolidation_monotonic +.. autocfunction:: primitives.h::z_query_consolidation_latest +.. autocfunction:: primitives.h::z_query_target_default + +.. TODO .. autocfunction:: primitives.h::z_reply_drop +.. TODO .. autocfunction:: primitives.h::z_reply_clone +.. autocfunction:: primitives.h::z_reply_is_ok +.. autocfunction:: primitives.h::z_reply_ok +.. autocfunction:: primitives.h::z_reply_err + +.. TODO .. autocfunction:: primitives.h::z_closure_reply_call +.. TODO .. autocfunction:: primitives.h::z_closure_reply_loan +.. TODO .. autocfunction:: primitives.h::z_closure_reply_drop +.. autocfunction:: primitives.h::z_closure_reply + +.. TODO .. autocfunction:: primitives.h::z_fifo_channel_reply_new +.. TODO .. autocfunction:: primitives.h::z_ring_channel_reply_new + +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_reply_drop +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_reply_loan +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_reply_recv +.. TODO .. autocfunction:: primitives.h::z_fifo_handler_reply_try_recv + +.. TODO .. autocfunction:: primitives.h::z_ring_handler_reply_drop +.. TODO .. autocfunction:: primitives.h::z_ring_handler_reply_loan +.. TODO .. autocfunction:: primitives.h::z_ring_handler_reply_recv +.. TODO .. autocfunction:: primitives.h::z_ring_handler_reply_try_recv + +Scouting +======== + +Types +----- +.. c:type:: z_owned_hello_t +.. c:type:: z_loaned_hello_t +.. c:type:: z_moved_hello_t + + Represents the content of a `hello` message returned by a zenoh entity as a reply to a `scout` message. -Represents a `sample` closure. +.. autoctype:: types.h::z_scout_options_t +.. TODO .. autoctype:: types.h::z_owned_closure_hello_t -.. c:type:: types.h::z_owned_closure_sample_t +Functions +--------- +.. autocfunction:: primitives.h::z_scout -Represents a loaned `sample` closure. +.. autocfunction:: primitives.h::z_hello_whatami +.. autocfunction:: primitives.h::z_hello_locators +.. autocfunction:: primitives.h::zp_hello_locators +.. autocfunction:: primitives.h::z_hello_zid +.. TODO .. autocfunction:: primitives.h::z_hello_loan +.. TODO .. autocfunction:: primitives.h::z_hello_clone +.. TODO .. autocfunction:: primitives.h::z_hello_drop -.. c:type:: types.h::z_loaned_closure_sample_t +.. autocfunction:: primitives.h::z_whatami_to_view_string -Represents a `query` closure. +.. autocfunction:: primitives.h::z_scout_options_default -.. c:type:: types.h::z_owned_closure_query_t +.. TODO .. autocfunction:: primitives.h::z_closure_hello_call +.. TODO .. autocfunction:: primitives.h::z_closure_hello_loan +.. TODO .. autocfunction:: primitives.h::z_closure_hello_drop +.. autocfunction:: primitives.h::z_closure_hello -Represents a loaned `query` closure. -.. c:type:: types.h::z_loaned_closure_query_t +.. TODO Logging +.. TODO ======= -Represents a `reply` closure. -.. c:type:: types.h::z_owned_closure_reply_t -Represents a loaned `reply` closure. -.. c:type:: types.h::z_loaned_closure_reply_t -Represents a `hello` closure. +Others +====== -.. c:type:: types.h::z_owned_closure_hello_t -Represents a loaned `hello` closure. +Data Structures +--------------- -.. c:type:: types.h::z_loaned_closure_hello_t +.. autoctype:: types.h::z_zint_t + +.. autoctype:: types.h::zp_task_read_options_t +.. autoctype:: types.h::zp_task_lease_options_t +.. autoctype:: types.h::zp_read_options_t +.. autoctype:: types.h::zp_send_keep_alive_options_t +.. autoctype:: types.h::zp_send_join_options_t -Represents a `Zenoh id` closure. +Closures +-------- -.. c:type:: types.h::z_owned_closure_zid_t +.. TODO: link or update -Represents a loaned `Zenoh id` closure. +A closure is a structure that contains all the elements for stateful, memory-leak-free callbacks: + - context: a pointer to an arbitrary state. + - call: the typical callback function. ``context`` will be passed as its last argument. + - drop: allows the callback's state to be freed. ``context`` will be passed as its last argument. -.. c:type:: types.h::z_loaned_closure_zid_t +Closures are not guaranteed not to be called concurrently. + +It is guaranteed that: + - ``call`` will never be called once ``drop`` has started. + - ``drop`` will only be called **once**, and **after every** ``call`` has ended. + - The two previous guarantees imply that ``call`` and ``drop`` are never called concurrently. Zenoh Functions --------------- Macros -~~~~~~ +^^^^^^ .. autocmacro:: macros.h::z_loan .. autocmacro:: macros.h::z_move .. autocmacro:: macros.h::z_clone @@ -300,208 +776,19 @@ Macros .. autocmacro:: macros.h::z_closure Primitives -~~~~~~~~~~ +^^^^^^^^^^ -.. autocfunction:: primitives.h::z_view_string_from_str -.. autocfunction:: primitives.h::z_view_string_from_substr -.. autocfunction:: primitives.h::z_view_keyexpr_from_str -.. autocfunction:: primitives.h::z_view_keyexpr_from_str_unchecked -.. autocfunction:: primitives.h::z_view_keyexpr_from_str_autocanonize -.. autocfunction:: primitives.h::z_keyexpr_as_view_string -.. autocfunction:: primitives.h::z_keyexpr_is_canon -.. autocfunction:: primitives.h::z_keyexpr_canonize -.. autocfunction:: primitives.h::z_keyexpr_canonize_null_terminated -.. autocfunction:: primitives.h::z_keyexpr_includes -.. autocfunction:: primitives.h::z_keyexpr_intersects -.. autocfunction:: primitives.h::z_keyexpr_equals .. autocfunction:: primitives.h::z_keyexpr_relation_to -.. autocfunction:: primitives.h::z_keyexpr_concat -.. autocfunction:: primitives.h::z_keyexpr_join -.. autocfunction:: primitives.h::z_config_new -.. autocfunction:: primitives.h::z_config_default -.. autocfunction:: primitives.h::zp_config_get -.. autocfunction:: primitives.h::zp_config_insert -.. autocfunction:: primitives.h::z_encoding_from_str -.. autocfunction:: primitives.h::z_encoding_from_substr -.. autocfunction:: primitives.h::z_encoding_set_schema_from_str -.. autocfunction:: primitives.h::z_encoding_set_schema_from_substr -.. autocfunction:: primitives.h::z_encoding_to_string -.. autocfunction:: primitives.h::z_encoding_equals -.. autocfunction:: primitives.h::z_reply_err_payload -.. autocfunction:: primitives.h::z_reply_err_encoding -.. autocfunction:: primitives.h::z_slice_from_buf -.. autocfunction:: primitives.h::z_slice_copy_from_buf -.. autocfunction:: primitives.h::z_slice_data -.. autocfunction:: primitives.h::z_slice_len -.. autocfunction:: primitives.h::z_slice_empty -.. autocfunction:: primitives.h::z_slice_is_empty -.. autocfunction:: serialization.h::ze_deserializer_from_bytes -.. autocfunction:: serialization.h::ze_deserializer_deserialize_int8 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_int16 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_int32 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_int64 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint8 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint16 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint32 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_uint64 -.. autocfunction:: serialization.h::ze_deserializer_deserialize_float -.. autocfunction:: serialization.h::ze_deserializer_deserialize_double -.. autocfunction:: serialization.h::ze_deserializer_deserialize_slice -.. autocfunction:: serialization.h::ze_deserializer_deserialize_string -.. autocfunction:: serialization.h::ze_deserializer_deserialize_sequence_length -.. autocfunction:: serialization.h::ze_serializer_empty -.. autocfunction:: serialization.h::ze_serializer_finish -.. autocfunction:: serialization.h::ze_serializer_serialize_int8 -.. autocfunction:: serialization.h::ze_serializer_serialize_int16 -.. autocfunction:: serialization.h::ze_serializer_serialize_int32 -.. autocfunction:: serialization.h::ze_serializer_serialize_int64 -.. autocfunction:: serialization.h::ze_serializer_serialize_uint8 -.. autocfunction:: serialization.h::ze_serializer_serialize_uint16 -.. autocfunction:: serialization.h::ze_serializer_serialize_uint32 -.. autocfunction:: serialization.h::ze_serializer_serialize_uint64 -.. autocfunction:: serialization.h::ze_serializer_serialize_float -.. autocfunction:: serialization.h::ze_serializer_serialize_double -.. autocfunction:: serialization.h::ze_serializer_serialize_slice -.. autocfunction:: serialization.h::ze_serializer_serialize_buf -.. autocfunction:: serialization.h::ze_serializer_serialize_string -.. autocfunction:: serialization.h::ze_serializer_serialize_str -.. autocfunction:: serialization.h::ze_serializer_serialize_sequence_length -.. autocfunction:: serialization.h::ze_deserialize_int8 -.. autocfunction:: serialization.h::ze_deserialize_int16 -.. autocfunction:: serialization.h::ze_deserialize_int32 -.. autocfunction:: serialization.h::ze_deserialize_int64 -.. autocfunction:: serialization.h::ze_deserialize_uint8 -.. autocfunction:: serialization.h::ze_deserialize_uint16 -.. autocfunction:: serialization.h::ze_deserialize_uint32 -.. autocfunction:: serialization.h::ze_deserialize_uint64 -.. autocfunction:: serialization.h::ze_deserialize_float -.. autocfunction:: serialization.h::ze_deserialize_double -.. autocfunction:: serialization.h::ze_deserialize_slice -.. autocfunction:: serialization.h::ze_deserialize_string -.. autocfunction:: serialization.h::ze_deserializer_is_done -.. autocfunction:: serialization.h::ze_serialize_int8 -.. autocfunction:: serialization.h::ze_serialize_int16 -.. autocfunction:: serialization.h::ze_serialize_int32 -.. autocfunction:: serialization.h::ze_serialize_int64 -.. autocfunction:: serialization.h::ze_serialize_uint8 -.. autocfunction:: serialization.h::ze_serialize_uint16 -.. autocfunction:: serialization.h::ze_serialize_uint32 -.. autocfunction:: serialization.h::ze_serialize_uint64 -.. autocfunction:: serialization.h::ze_serialize_float -.. autocfunction:: serialization.h::ze_serialize_double -.. autocfunction:: serialization.h::ze_serialize_slice -.. autocfunction:: serialization.h::ze_serialize_buf -.. autocfunction:: serialization.h::ze_serialize_string -.. autocfunction:: serialization.h::ze_serialize_str -.. autocfunction:: primitives.h::z_bytes_from_slice -.. autocfunction:: primitives.h::z_bytes_copy_from_slice -.. autocfunction:: primitives.h::z_bytes_from_buf -.. autocfunction:: primitives.h::z_bytes_copy_from_buf -.. autocfunction:: primitives.h::z_bytes_from_static_buf -.. autocfunction:: primitives.h::z_bytes_from_string -.. autocfunction:: primitives.h::z_bytes_copy_from_string -.. autocfunction:: primitives.h::z_bytes_from_str -.. autocfunction:: primitives.h::z_bytes_copy_from_str -.. autocfunction:: primitives.h::z_bytes_from_static_str -.. autocfunction:: primitives.h::z_bytes_empty -.. autocfunction:: primitives.h::z_bytes_len -.. autocfunction:: primitives.h::z_bytes_is_empty -.. autocfunction:: primitives.h::z_bytes_get_slice_iterator -.. autocfunction:: primitives.h::z_bytes_slice_iterator_next -.. autocfunction:: primitives.h::z_bytes_get_reader -.. autocfunction:: primitives.h::z_bytes_reader_read -.. autocfunction:: primitives.h::z_bytes_reader_seek -.. autocfunction:: primitives.h::z_bytes_reader_tell -.. autocfunction:: primitives.h::z_bytes_reader_remaining -.. autocfunction:: primitives.h::z_bytes_writer_empty -.. autocfunction:: primitives.h::z_bytes_writer_finish -.. autocfunction:: primitives.h::z_bytes_writer_write_all -.. autocfunction:: primitives.h::z_bytes_writer_append .. autocfunction:: primitives.h::z_timestamp_check -.. autocfunction:: primitives.h::z_query_target_default -.. autocfunction:: primitives.h::z_query_consolidation_auto -.. autocfunction:: primitives.h::z_query_consolidation_default -.. autocfunction:: primitives.h::z_query_consolidation_latest -.. autocfunction:: primitives.h::z_query_consolidation_monotonic -.. autocfunction:: primitives.h::z_query_consolidation_none -.. autocfunction:: primitives.h::z_query_parameters -.. autocfunction:: primitives.h::z_query_payload -.. autocfunction:: primitives.h::z_query_encoding -.. autocfunction:: primitives.h::z_query_attachment -.. autocfunction:: primitives.h::z_query_keyexpr -.. autocfunction:: primitives.h::z_closure_sample -.. autocfunction:: primitives.h::z_closure_query -.. autocfunction:: primitives.h::z_closure_reply -.. autocfunction:: primitives.h::z_closure_hello -.. autocfunction:: primitives.h::z_closure_zid -.. autocfunction:: primitives.h::z_sample_loan -.. autocfunction:: primitives.h::z_string_data -.. autocfunction:: primitives.h::z_string_len -.. autocfunction:: primitives.h::z_string_from_str -.. autocfunction:: primitives.h::z_string_copy_from_str -.. autocfunction:: primitives.h::z_string_copy_from_substr -.. autocfunction:: primitives.h::z_string_empty -.. autocfunction:: primitives.h::z_string_is_empty .. autocfunction:: primitives.h::z_string_as_slice -.. autocfunction:: primitives.h::z_hello_zid -.. autocfunction:: primitives.h::z_hello_whatami -.. autocfunction:: primitives.h::z_hello_locators -.. autocfunction:: primitives.h::zp_hello_locators -.. autocfunction:: primitives.h::z_whatami_to_view_string -.. autocfunction:: primitives.h::z_scout -.. autocfunction:: primitives.h::z_open -.. autocfunction:: primitives.h::z_close -.. autocfunction:: primitives.h::z_info_peers_zid -.. autocfunction:: primitives.h::z_info_routers_zid -.. autocfunction:: primitives.h::z_info_zid -.. autocfunction:: primitives.h::z_sample_keyexpr -.. autocfunction:: primitives.h::z_sample_payload -.. autocfunction:: primitives.h::z_sample_timestamp -.. autocfunction:: primitives.h::z_sample_encoding + + +.. autocfunction:: primitives.h::z_subscriber_keyexpr .. autocfunction:: primitives.h::z_sample_kind -.. autocfunction:: primitives.h::z_sample_reliability -.. autocfunction:: primitives.h::z_sample_attachment -.. autocfunction:: primitives.h::z_put_options_default -.. autocfunction:: primitives.h::z_delete_options_default -.. autocfunction:: primitives.h::z_put -.. autocfunction:: primitives.h::z_delete -.. autocfunction:: primitives.h::z_publisher_options_default -.. autocfunction:: primitives.h::z_declare_publisher -.. autocfunction:: primitives.h::z_undeclare_publisher -.. autocfunction:: primitives.h::z_publisher_put_options_default -.. autocfunction:: primitives.h::z_publisher_delete_options_default -.. autocfunction:: primitives.h::z_publisher_put -.. autocfunction:: primitives.h::z_publisher_delete -.. autocfunction:: primitives.h::z_get_options_default -.. autocfunction:: primitives.h::z_get -.. autocfunction:: primitives.h::z_reply_is_ok -.. autocfunction:: primitives.h::z_reply_ok -.. autocfunction:: primitives.h::z_reply_err -.. autocfunction:: primitives.h::z_queryable_options_default -.. autocfunction:: primitives.h::z_declare_queryable -.. autocfunction:: primitives.h::z_undeclare_queryable -.. autocfunction:: primitives.h::z_query_reply_options_default -.. autocfunction:: primitives.h::z_query_reply .. autocfunction:: primitives.h::z_query_reply_del_options_default .. autocfunction:: primitives.h::z_query_reply_del -.. autocfunction:: primitives.h::z_query_reply_err_options_default -.. autocfunction:: primitives.h::z_query_reply_err -.. autocfunction:: primitives.h::z_keyexpr_from_str -.. autocfunction:: primitives.h::z_keyexpr_from_substr -.. autocfunction:: primitives.h::z_keyexpr_from_str_autocanonize -.. autocfunction:: primitives.h::z_keyexpr_from_substr_autocanonize -.. autocfunction:: primitives.h::z_string_array_new -.. autocfunction:: primitives.h::z_string_array_push_by_alias -.. autocfunction:: primitives.h::z_string_array_push_by_copy -.. autocfunction:: primitives.h::z_string_array_get -.. autocfunction:: primitives.h::z_string_array_len -.. autocfunction:: primitives.h::z_string_array_is_empty -.. autocfunction:: primitives.h::z_declare_keyexpr -.. autocfunction:: primitives.h::z_undeclare_keyexpr -.. autocfunction:: primitives.h::z_subscriber_options_default -.. autocfunction:: primitives.h::z_declare_subscriber -.. autocfunction:: primitives.h::z_undeclare_subscriber -.. autocfunction:: primitives.h::z_subscriber_keyexpr + + .. autocfunction:: primitives.h::zp_task_read_options_default .. autocfunction:: primitives.h::zp_start_read_task .. autocfunction:: primitives.h::zp_stop_read_task @@ -514,69 +801,4 @@ Primitives .. autocfunction:: primitives.h::zp_send_keep_alive .. autocfunction:: primitives.h::zp_send_join_options_default .. autocfunction:: primitives.h::zp_send_join -.. autocfunction:: encoding.h::z_encoding_zenoh_bytes -.. autocfunction:: encoding.h::z_encoding_zenoh_int8 -.. autocfunction:: encoding.h::z_encoding_zenoh_int16 -.. autocfunction:: encoding.h::z_encoding_zenoh_int32 -.. autocfunction:: encoding.h::z_encoding_zenoh_int64 -.. autocfunction:: encoding.h::z_encoding_zenoh_int128 -.. autocfunction:: encoding.h::z_encoding_zenoh_uint8 -.. autocfunction:: encoding.h::z_encoding_zenoh_uint16 -.. autocfunction:: encoding.h::z_encoding_zenoh_uint32 -.. autocfunction:: encoding.h::z_encoding_zenoh_uint64 -.. autocfunction:: encoding.h::z_encoding_zenoh_uint128 -.. autocfunction:: encoding.h::z_encoding_zenoh_float32 -.. autocfunction:: encoding.h::z_encoding_zenoh_float64 -.. autocfunction:: encoding.h::z_encoding_zenoh_bool -.. autocfunction:: encoding.h::z_encoding_zenoh_string -.. autocfunction:: encoding.h::z_encoding_zenoh_error -.. autocfunction:: encoding.h::z_encoding_application_octet_stream -.. autocfunction:: encoding.h::z_encoding_text_plain -.. autocfunction:: encoding.h::z_encoding_application_json -.. autocfunction:: encoding.h::z_encoding_text_json -.. autocfunction:: encoding.h::z_encoding_application_cdr -.. autocfunction:: encoding.h::z_encoding_application_cbor -.. autocfunction:: encoding.h::z_encoding_application_yaml -.. autocfunction:: encoding.h::z_encoding_text_yaml -.. autocfunction:: encoding.h::z_encoding_text_json5 -.. autocfunction:: encoding.h::z_encoding_application_python_serialized_object -.. autocfunction:: encoding.h::z_encoding_application_protobuf -.. autocfunction:: encoding.h::z_encoding_application_java_serialized_object -.. autocfunction:: encoding.h::z_encoding_application_openmetrics_text -.. autocfunction:: encoding.h::z_encoding_image_png -.. autocfunction:: encoding.h::z_encoding_image_jpeg -.. autocfunction:: encoding.h::z_encoding_image_gif -.. autocfunction:: encoding.h::z_encoding_image_bmp -.. autocfunction:: encoding.h::z_encoding_image_webp -.. autocfunction:: encoding.h::z_encoding_application_xml -.. autocfunction:: encoding.h::z_encoding_application_x_www_form_urlencoded -.. autocfunction:: encoding.h::z_encoding_text_html -.. autocfunction:: encoding.h::z_encoding_text_xml -.. autocfunction:: encoding.h::z_encoding_text_css -.. autocfunction:: encoding.h::z_encoding_text_javascript -.. autocfunction:: encoding.h::z_encoding_text_markdown -.. autocfunction:: encoding.h::z_encoding_text_csv -.. autocfunction:: encoding.h::z_encoding_application_sql -.. autocfunction:: encoding.h::z_encoding_application_coap_payload -.. autocfunction:: encoding.h::z_encoding_application_json_patch_json -.. autocfunction:: encoding.h::z_encoding_application_json_seq -.. autocfunction:: encoding.h::z_encoding_application_jsonpath -.. autocfunction:: encoding.h::z_encoding_application_jwt -.. autocfunction:: encoding.h::z_encoding_application_mp4 -.. autocfunction:: encoding.h::z_encoding_application_soap_xml -.. autocfunction:: encoding.h::z_encoding_application_yang -.. autocfunction:: encoding.h::z_encoding_audio_aac -.. autocfunction:: encoding.h::z_encoding_audio_flac -.. autocfunction:: encoding.h::z_encoding_audio_mp4 -.. autocfunction:: encoding.h::z_encoding_audio_ogg -.. autocfunction:: encoding.h::z_encoding_audio_vorbis -.. autocfunction:: encoding.h::z_encoding_video_h261 -.. autocfunction:: encoding.h::z_encoding_video_h263 -.. autocfunction:: encoding.h::z_encoding_video_h264 -.. autocfunction:: encoding.h::z_encoding_video_h265 -.. autocfunction:: encoding.h::z_encoding_video_h266 -.. autocfunction:: encoding.h::z_encoding_video_mp4 -.. autocfunction:: encoding.h::z_encoding_video_ogg -.. autocfunction:: encoding.h::z_encoding_video_raw -.. autocfunction:: encoding.h::z_encoding_video_vp8 -.. autocfunction:: encoding.h::z_encoding_video_vp9 +