zenoh-c
The libzenoh-c library provides a C client API for the zenoh protocol.
An introduction to zenoh and its concepts is available on zenoh.io.
- Concepts
- Examples
- API Reference
- Containers
- Slice
- String
- Types
- Functions
z_string_loan()z_view_string_loan()z_string_drop()z_string_clone()z_string_empty()z_view_string_empty()z_string_copy_from_str()z_view_string_from_str()z_string_copy_from_substr()z_view_string_from_substr()z_string_from_str()z_string_data()z_string_len()z_string_is_empty()z_string_as_slice()
- String Array
- Common
- Key expression
- Types
- Functions
z_keyexpr_from_str()z_view_keyexpr_from_str()z_keyexpr_from_str_autocanonize()z_view_keyexpr_from_str_autocanonize()z_view_keyexpr_from_str_unchecked()z_keyexpr_from_substr()z_view_keyexpr_from_substr()z_keyexpr_from_substr_autocanonize()z_view_keyexpr_from_substr_autocanonize()z_view_keyexpr_from_substr_unchecked()z_keyexpr_loan()z_view_keyexpr_loan()z_keyexpr_clone()z_keyexpr_drop()z_keyexpr_as_view_string()z_keyexpr_canonize()z_keyexpr_canonize_null_terminated()z_keyexpr_is_canon()z_keyexpr_concat()z_keyexpr_join()z_keyexpr_equals()z_keyexpr_includes()z_keyexpr_intersects()z_keyexpr_relation_to()z_declare_keyexpr()z_undeclare_keyexpr()
- Encoding
- Types
- Functions
- Predefined Encodings
z_encoding_zenoh_bytes()z_encoding_zenoh_string()z_encoding_zenoh_serialized()z_encoding_application_octet_stream()z_encoding_text_plain()z_encoding_application_json()z_encoding_text_json()z_encoding_application_cdr()z_encoding_application_cbor()z_encoding_application_yaml()z_encoding_text_yaml()z_encoding_text_json5()z_encoding_application_python_serialized_object()z_encoding_application_protobuf()z_encoding_application_java_serialized_object()z_encoding_application_openmetrics_text()z_encoding_image_png()z_encoding_image_jpeg()z_encoding_image_gif()z_encoding_image_bmp()z_encoding_image_webp()z_encoding_application_xml()z_encoding_application_x_www_form_urlencoded()z_encoding_text_html()z_encoding_text_xml()z_encoding_text_css()z_encoding_text_javascript()z_encoding_text_markdown()z_encoding_text_csv()z_encoding_application_sql()z_encoding_application_coap_payload()z_encoding_application_json_patch_json()z_encoding_application_json_seq()z_encoding_application_jsonpath()z_encoding_application_jwt()z_encoding_application_mp4()z_encoding_application_soap_xml()z_encoding_application_yang()z_encoding_audio_aac()z_encoding_audio_flac()z_encoding_audio_mp4()z_encoding_audio_ogg()z_encoding_audio_vorbis()z_encoding_video_h261()z_encoding_video_h263()z_encoding_video_h264()z_encoding_video_h265()z_encoding_video_h266()z_encoding_video_mp4()z_encoding_video_ogg()z_encoding_video_raw()z_encoding_video_vp8()z_encoding_video_vp9()
- Reply Error
- Sample
- Types
- Functions
z_sample_loan()z_sample_loan_mut()z_sample_drop()z_sample_clone()z_sample_timestamp()z_sample_attachment()z_sample_encoding()z_sample_payload()z_sample_payload_mut()z_sample_priority()z_sample_congestion_control()z_sample_express()z_sample_reliability()z_sample_keyexpr()z_sample_kind()
- Timestamp
- Payload
- Types
- Functions
z_bytes_len()z_bytes_copy_from_slice()z_bytes_from_slice()z_bytes_copy_from_buf()z_bytes_from_buf()z_bytes_from_static_buf()z_bytes_copy_from_string()z_bytes_from_string()z_bytes_copy_from_str()z_bytes_from_str()z_bytes_from_static_str()z_bytes_to_slice()z_bytes_to_string()z_bytes_empty()z_bytes_clone()z_bytes_loan()z_bytes_loan_mut()z_bytes_drop()z_bytes_get_slice_iterator()z_bytes_slice_iterator_next()z_bytes_get_contiguous_view()z_bytes_get_reader()z_bytes_reader_read()z_bytes_reader_seek()z_bytes_reader_tell()z_bytes_reader_remaining()z_bytes_writer_empty()z_bytes_writer_finish()z_bytes_writer_write_all()z_bytes_writer_append()z_bytes_as_mut_loaned_shm()
- Key expression
- System
- Session
- Matching
- Publication
- Types
- Functions
z_put()z_delete()z_declare_publisher()z_undeclare_publisher()z_publisher_put()z_publisher_delete()z_publisher_keyexpr()z_publisher_id()z_publisher_loan()z_publisher_drop()z_put_options_default()z_delete_options_default()z_publisher_options_default()z_publisher_put_options_default()z_publisher_delete_options_default()z_reliability_default()z_publisher_get_matching_status()z_publisher_declare_matching_listener()z_publisher_declare_background_matching_listener()
- Subscription
- Types
- Functions
z_declare_subscriber()z_undeclare_subscriber()z_declare_background_subscriber()z_subscriber_keyexpr()z_subscriber_id()z_subscriber_drop()z_closure_sample_call()z_closure_sample_loan()z_closure_sample_drop()z_closure_sample()z_subscriber_options_default()z_fifo_channel_sample_new()z_ring_channel_sample_new()z_fifo_handler_sample_drop()z_fifo_handler_sample_loan()z_fifo_handler_sample_recv()z_fifo_handler_sample_try_recv()z_ring_handler_sample_drop()z_ring_handler_sample_loan()z_ring_handler_sample_recv()z_ring_handler_sample_try_recv()
- Queryable
- Types
z_owned_queryable_tz_loaned_queryable_tz_owned_query_tz_loaned_query_tz_loaned_closure_query_tz_owned_closure_query_tz_queryable_options_tz_query_reply_options_tz_query_reply_err_options_tz_query_reply_del_options_tz_owned_fifo_handler_query_tz_loaned_fifo_handler_query_tz_owned_ring_handler_query_tz_loaned_ring_handler_query_t
- Functions
z_declare_queryable()z_undeclare_queryable()z_declare_background_queryable()z_queryable_id()z_queryable_keyexpr()z_queryable_options_default()z_query_reply_options_default()z_query_reply_err_options_default()z_query_reply_del_options_default()z_queryable_loan()z_queryable_drop()z_query_loan()z_query_loan_mut()z_query_drop()z_query_clone()z_query_keyexpr()z_query_parameters()z_query_payload()z_query_payload_mut()z_query_encoding()z_query_attachment()z_query_attachment_mut()z_query_reply()z_query_reply_err()z_query_reply_del()z_closure_query_call()z_closure_query_loan()z_closure_query_drop()z_closure_query()z_fifo_channel_query_new()z_ring_channel_query_new()z_fifo_handler_query_drop()z_fifo_handler_query_loan()z_fifo_handler_query_recv()z_fifo_handler_query_try_recv()z_ring_handler_query_drop()z_ring_handler_query_loan()z_ring_handler_query_recv()z_ring_handler_query_try_recv()
- Types
- Query
- Types
z_owned_querier_tz_loaned_querier_tz_owned_reply_tz_loaned_reply_tz_loaned_closure_reply_tz_owned_closure_reply_tz_get_options_tz_get_options_t::targetz_get_options_t::consolidationz_get_options_t::payloadz_get_options_t::encodingz_get_options_t::congestion_controlz_get_options_t::is_expressz_get_options_t::allowed_destinationz_get_options_t::accept_repliesz_get_options_t::priorityz_get_options_t::source_infoz_get_options_t::attachmentz_get_options_t::timeout_ms
z_query_target_tz_consolidation_mode_tzc_reply_keyexpr_tz_query_consolidation_tz_querier_options_tz_querier_get_options_tz_owned_fifo_handler_reply_tz_loaned_fifo_handler_reply_tz_owned_ring_handler_reply_tz_loaned_ring_handler_reply_t
- Functions
z_get()z_get_options_default()z_query_consolidation_default()z_query_consolidation_auto()z_query_consolidation_none()z_query_consolidation_monotonic()z_query_consolidation_latest()z_query_target_default()zc_reply_keyexpr_default()z_declare_querier()z_undeclare_querier()z_querier_loan()z_querier_drop()z_querier_id()z_querier_keyexpr()z_querier_get()z_querier_get_matching_status()z_querier_declare_matching_listener()z_querier_declare_background_matching_listener()z_querier_options_default()z_querier_get_options_default()z_reply_drop()z_reply_clone()z_reply_loan()z_reply_loan_mut()z_reply_is_ok()z_reply_ok()z_reply_ok_mut()z_reply_err()z_reply_err_mut()z_closure_reply_call()z_closure_reply_loan()z_closure_reply_drop()z_closure_reply()z_fifo_channel_reply_new()z_ring_channel_reply_new()z_fifo_handler_reply_drop()z_fifo_handler_reply_loan()z_fifo_handler_reply_recv()z_fifo_handler_reply_try_recv()z_ring_handler_reply_drop()z_ring_handler_reply_loan()z_ring_handler_reply_recv()z_ring_handler_reply_try_recv()
- Types
- Scouting
- Liveliness
- Types
- Functions
z_liveliness_declare_subscriber()z_liveliness_declare_background_subscriber()z_liveliness_get()z_liveliness_declare_token()z_liveliness_undeclare_token()z_liveliness_token_loan()z_liveliness_token_drop()z_liveliness_subscriber_options_default()z_liveliness_token_options_default()z_liveliness_get_options_default()
- Logging
- Other
- Ext
- Serialization / Deserialization
- Types
- Functions
ze_serialize_slice()ze_serialize_buf()ze_serialize_string()ze_serialize_str()ze_serialize_substr()ze_serialize_uint8()ze_serialize_uint16()ze_serialize_uint32()ze_serialize_uint64()ze_serialize_int8()ze_serialize_int16()ze_serialize_int32()ze_serialize_int64()ze_serialize_float()ze_serialize_double()ze_serialize_bool()ze_deserialize_slice()ze_deserialize_string()ze_deserialize_uint8()ze_deserialize_uint16()ze_deserialize_uint32()ze_deserialize_uint64()ze_deserialize_int8()ze_deserialize_int16()ze_deserialize_int32()ze_deserialize_int64()ze_deserialize_float()ze_deserialize_double()ze_deserialize_bool()ze_serializer_empty()ze_serializer_finish()ze_serializer_serialize_slice()ze_serializer_serialize_buf()ze_serializer_serialize_string()ze_serializer_serialize_str()ze_serializer_serialize_substr()ze_serializer_serialize_uint8()ze_serializer_serialize_uint16()ze_serializer_serialize_uint32()ze_serializer_serialize_uint64()ze_serializer_serialize_int8()ze_serializer_serialize_int16()ze_serializer_serialize_int32()ze_serializer_serialize_int64()ze_serializer_serialize_float()ze_serializer_serialize_double()ze_serializer_serialize_bool()ze_serializer_serialize_sequence_length()ze_deserializer_from_bytes()ze_deserializer_is_done()ze_deserializer_deserialize_slice()ze_deserializer_deserialize_string()ze_deserializer_deserialize_uint8()ze_deserializer_deserialize_uint16()ze_deserializer_deserialize_uint32()ze_deserializer_deserialize_uint64()ze_deserializer_deserialize_int8()ze_deserializer_deserialize_int16()ze_deserializer_deserialize_int32()ze_deserializer_deserialize_int64()ze_deserializer_deserialize_float()ze_deserializer_deserialize_double()ze_deserializer_deserialize_bool()ze_deserializer_deserialize_sequence_length()
- Advanced Publisher
- Types
- Functions
ze_declare_advanced_publisher()ze_undeclare_advanced_publisher()ze_advanced_publisher_put()ze_advanced_publisher_delete()ze_advanced_publisher_keyexpr()ze_advanced_publisher_id()ze_advanced_publisher_loan()ze_advanced_publisher_drop()ze_advanced_publisher_options_default()ze_advanced_publisher_cache_options_default()ze_advanced_publisher_sample_miss_detection_options_default()ze_advanced_publisher_put_options_default()ze_advanced_publisher_delete_options_default()ze_advanced_publisher_get_matching_status()ze_advanced_publisher_declare_matching_listener()ze_advanced_publisher_declare_background_matching_listener()
- Advanced Subscriber
- Types
ze_owned_advanced_subscriber_tze_loaned_advanced_subscriber_tze_advanced_subscriber_history_options_tze_advanced_subscriber_recovery_options_tze_advanced_subscriber_last_sample_miss_detection_options_tze_advanced_subscriber_options_tze_advanced_subscriber_options_t::subscriber_optionsze_advanced_subscriber_options_t::historyze_advanced_subscriber_options_t::recoveryze_advanced_subscriber_options_t::query_timeout_msze_advanced_subscriber_options_t::subscriber_detectionze_advanced_subscriber_options_t::subscriber_detection_metadata
- Functions
ze_declare_advanced_subscriber()ze_declare_background_advanced_subscriber()ze_undeclare_advanced_subscriber()ze_advanced_subscriber_keyexpr()ze_advanced_subscriber_id()ze_advanced_subscriber_detect_publishers()ze_advanced_subscriber_detect_publishers_background()ze_advanced_subscriber_drop()ze_advanced_subscriber_history_options_default()ze_advanced_subscriber_recovery_options_default()ze_advanced_subscriber_last_sample_miss_detection_options_default()ze_advanced_subscriber_options_default()
- Types
- Publication Cache (deprecated)
- Querying Subscriber (deprecated)
- Types
ze_owned_querying_subscriber_tze_loaned_querying_subscriber_tze_querying_subscriber_options_tze_querying_subscriber_options_t::allowed_originze_querying_subscriber_options_t::query_selectorze_querying_subscriber_options_t::query_targetze_querying_subscriber_options_t::query_consolidationze_querying_subscriber_options_t::query_accept_repliesze_querying_subscriber_options_t::query_timeout_ms
- Functions
- Types
- Serialization / Deserialization
- Containers