zenoh-cpp
The zenoh-cpp library provides a client C++ API for the zenoh network protocol.
An introduction to Zenoh and its concepts is available on zenoh.io. Since the zenoh-cpp is a header-only wrapper library over the zenoh-c and zenoh-pico C libraries, it can be useful to reference the documentation of these libraries as well. The zenoh-c library is C interface to main implementation of zenoh in Rust (see zenoh Rust API api documentation for more information).
- Examples
- API Reference
- Commonly used types
- Enums
- Source Info
- Timestamp
- Encoding
zenoh::EncodingEncoding()Encoding()Encoding()as_string()set_schema()operator=()operator==()zenoh::Encoding::Predefinedzenoh_bytes()zenoh_string()zenoh_serialized()application_octet_stream()text_plain()application_json()text_json()application_cdr()application_cbor()application_yaml()text_yaml()text_json5()application_python_serialized_object()application_protobuf()application_java_serialized_object()application_openmetrics_text()image_png()image_jpeg()image_gif()image_bmp()image_webp()application_xml()application_x_www_form_urlencoded()text_html()text_xml()text_css()text_javascript()text_markdown()text_csv()application_sql()application_coap_payload()application_json_patch_json()application_json_seq()application_jsonpath()application_jwt()application_mp4()application_soap_xml()application_yang()audio_aac()audio_flac()audio_mp4()audio_ogg()audio_vorbis()video_h261()video_h263()video_h264()video_h265()video_h266()video_mp4()video_ogg()video_raw()video_vp8()video_vp9()
- Sample
- Bytes
zenoh::BytesBytes()Bytes()Bytes()Bytes()Bytes()Bytes()Bytes()clone()Bytes()Bytes()Bytes()as_vector()as_string()get_contiguous_view()as_shm()as_shm()size()slice_iter()reader()zenoh::Bytes::ReaderReader()read()tell()remaining()seek_from_current()seek_from_start()seek_from_end()zenoh::Bytes::SliceIteratornext()zenoh::Bytes::WriterWriter()write_all()append()finish()
- Logging
- Error Handling
- Key Expression
- Configuration
- Session Management
- Session
zenoh::SessionSession()Session()open()open()get_zid()declare_keyexpr()undeclare_keyexpr()get()get()declare_queryable()declare_background_queryable()declare_queryable()declare_subscriber()declare_background_subscriber()declare_subscriber()delete_resource()put()declare_publisher()declare_querier()get_routers_z_id()get_peers_z_id()start_read_task()stop_read_task()start_lease_task()stop_lease_task()read()send_keep_alive()send_join()liveliness_declare_token()liveliness_declare_subscriber()liveliness_declare_background_subscriber()liveliness_declare_subscriber()liveliness_get()liveliness_get()new_timestamp()close()is_closed()ext()zenoh::Session::DeleteOptionsprioritycongestion_controlis_expressreliabilitytimestampcreate_default()zenoh::Session::GetOptionstargetconsolidationprioritycongestion_controlis_expresspayloadencodingsource_infoaccept_repliesallowed_destinationattachmenttimeout_mscreate_default()zenoh::Session::LivelinessDeclarationOptionscreate_default()zenoh::Session::LivelinessGetOptionstimeout_mscreate_default()zenoh::Session::LivelinessSubscriberOptionshistorycreate_default()zenoh::Session::PublisherOptionscongestion_controlpriorityis_expressreliabilityallowed_destinationencodingcreate_default()zenoh::Session::PutOptionsprioritycongestion_controlis_expressallowed_destinationtimestampencodingreliabilitysource_infoattachmentcreate_default()zenoh::Session::QuerierOptionstargetconsolidationprioritycongestion_controlis_expressaccept_repliesallowed_destinationtimeout_mscreate_default()zenoh::Session::QueryableOptionscompleteallowed_origincreate_default()zenoh::Session::SessionCloseOptionszenoh::Session::SessionOptionsstart_background_taskszenoh::Session::SubscriberOptionsallowed_origincreate_default()
- Session
- Scouting
- Publish-Subscribe
zenoh::Publisherput()delete_resource()get_keyexpr()undeclare()get_id()declare_matching_listener()declare_matching_listener()declare_background_matching_listener()get_matching_status()zenoh::Publisher::DeleteOptionstimestampcreate_default()zenoh::Publisher::PutOptionsencodingtimestampsource_infoattachmentcreate_default()zenoh::Subscriberundeclare()handler()Subscriber()
- Query-Reply
zenoh::Querierget()get()get_keyexpr()undeclare()get_id()declare_matching_listener()declare_matching_listener()declare_background_matching_listener()get_matching_status()zenoh::Querier::GetOptionspayloadencodingsource_infoattachmentcreate_default()zenoh::Queryablehandler()undeclare()Queryable()zenoh::Queryget_keyexpr()get_parameters()get_payload()get_payload()get_encoding()get_attachment()get_attachment()reply()reply_err()reply_del()clone()zenoh::Query::ReplyDelOptionszenoh::Query::ReplyErrOptionscreate_default()zenoh::Query::ReplyOptionscreate_default()zenoh::QueryConsolidationQueryConsolidation()QueryConsolidation()operator==()operator!=()zenoh::Replyis_ok()get_ok()get_err()get_replier_id()clone()zenoh::ReplyErrorget_payload()get_payload()get_encoding()
- Matching
- Channels
- Interoperability with zenoh-c / zenoh-pico
as_owned_c_ptr()as_owned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()as_owned_c_ptr()as_owned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()as_owned_c_ptr()as_owned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()as_copyable_c_ptr()as_copyable_c_ptr()as_copyable_c_ptr()as_copyable_c_ptr()as_owned_c_ptr()as_owned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()as_owned_cpp_ref()as_owned_cpp_ref()as_owned_cpp_ref()as_copyable_cpp_ref()as_copyable_cpp_ref()move_to_c_obj()into_copyable_cpp_obj()as_owned_c_ptr()as_owned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()as_owned_c_ptr()as_owned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()as_owned_c_ptr()as_owned_c_ptr()as_loaned_c_ptr()as_loaned_c_ptr()as_moved_c_ptr()as_moved_c_ptr()move_to_c_obj()
- Shared Memory
zenoh::ZShmZShm()ZShm()data()len()try_mutate()try_mutate()zenoh::ZShmMutdata()data()len()zenoh::CppShmClientzenoh::ShmClientShmClient()zenoh::CppShmSegmentzenoh::ShmClientStorageglobal()ShmClientStorage()ShmClientStorage()ShmClientStorage()ShmClientStorage()zenoh::PosixShmClientPosixShmClient()zenoh::PosixShmProviderPosixShmProvider()zenoh::CppShmProviderCppShmProvider()CppShmProvider()zenoh::AllocLayoutAllocLayout()zenoh::MemoryLayoutMemoryLayout()zenoh::ChunkAllocResultChunkAllocResult()ChunkAllocResult()ProtocolIdSegmentIdChunkIdChunkDescriptorAllocatedChunkAllocErrorLayoutErrorAllocAlignmentBufAllocResultBufLayoutAllocResultcleanup_orphaned_shm_segments()
- Extensions
- Serialization / Deserialization
- Session Extension
zenoh::ext::SessionExtSessionExt()declare_publication_cache()declare_background_publication_cache()declare_querying_subscriber()declare_background_querying_subscriber()declare_querying_subscriber()declare_advanced_publisher()declare_advanced_subscriber()declare_background_advanced_subscriber()declare_advanced_subscriber()zenoh::ext::SessionExt::AdvancedPublisherOptionspublisher_optionscachesample_miss_detectionpublisher_detectionpublisher_detection_metadatacreate_default()zenoh::ext::SessionExt::AdvancedPublisherOptions::CacheOptionsmax_samplescongestion_controlpriorityis_expresscreate_default()zenoh::ext::SessionExt::AdvancedPublisherOptions::SampleMissDetectionOptionsheartbeatheartbeat_period_mscreate_default()zenoh::ext::SessionExt::AdvancedPublisherOptions::SampleMissDetectionOptions::HeartbeatNonezenoh::ext::SessionExt::AdvancedPublisherOptions::SampleMissDetectionOptions::HeartbeatPeriodiczenoh::ext::SessionExt::AdvancedPublisherOptions::SampleMissDetectionOptions::HeartbeatSporadiczenoh::ext::SessionExt::AdvancedSubscriberOptionssubscriber_optionshistoryrecoveryquery_timeout_mssubscriber_detectionsubscriber_detection_metadatacreate_default()zenoh::ext::SessionExt::AdvancedSubscriberOptions::HistoryOptionsdetect_late_publishersmax_samplesmax_age_mscreate_default()zenoh::ext::SessionExt::AdvancedSubscriberOptions::RecoveryOptionslast_sample_miss_detectioncreate_default()zenoh::ext::SessionExt::AdvancedSubscriberOptions::RecoveryOptions::Heartbeatzenoh::ext::SessionExt::AdvancedSubscriberOptions::RecoveryOptions::PeriodicQueriesOptionsperiod_mscreate_default()zenoh::ext::SessionExt::PublicationCacheOptionscreate_default()zenoh::ext::SessionExt::QueryingSubscriberOptionsquery_keyexprallowed_originquery_accept_repliesquery_targetquery_consolidationquery_timeout_mscreate_default()zenoh::ext::PublicationCacheget_keyexpr()undeclare()zenoh::ext::QueryingSubscriberundeclare()handler()QueryingSubscriber()get()zenoh::ext::AdvancedPublisherget_keyexpr()undeclare()get_id()put()delete_resource()declare_matching_listener()declare_matching_listener()declare_background_matching_listener()get_matching_status()zenoh::ext::AdvancedPublisher::DeleteOptionsdelete_optionscreate_default()zenoh::ext::AdvancedPublisher::PutOptionsput_optionscreate_default()zenoh::ext::AdvancedSubscriberAdvancedSubscriber()undeclare()handler()declare_sample_miss_listener()declare_background_sample_miss_listener()detect_publishers()detect_publishers()detect_publishers_background()get_keyexpr()get_id()zenoh::ext::Misssourcenbzenoh::ext::SampleMissListenerundeclare()handler()SampleMissListener()
- Commonly used types
- Index