API Reference

• Headers and namespaces
• Base templates
  • Copyable
    • Copyable::Copyable()
    • Copyable::Copyable()
    • Copyable::Copyable()
  • Owned
    • Owned::operator ZC_OWNED_TYPE&()
    • Owned::operator const ZC_OWNED_TYPE&()
    • Owned::Owned()
    • Owned::operator=()
    • Owned::Owned()
    • Owned::Owned()
    • Owned::Owned()
    • Owned::Owned()
    • Owned::operator=()
    • Owned::~Owned()
    • Owned::drop()
    • Owned::take()
    • Owned::put()
    • Owned::check()
    • Owned::loan()
• Closure templates
  • ClosureConstRefParam
    • ClosureConstRefParam::ClosureConstRefParam()
    • ClosureConstRefParam::ClosureConstRefParam()
    • ClosureConstRefParam::ClosureConstRefParam()
    • ClosureConstRefParam::check()
    • ClosureConstRefParam::call()
    • ClosureConstRefParam::operator()()
  • ClosureMoveParam
    • ClosureMoveParam::ClosureMoveParam()
    • ClosureMoveParam::ClosureMoveParam()
    • ClosureMoveParam::ClosureMoveParam()
    • ClosureMoveParam::check()
    • ClosureMoveParam::call()
    • ClosureMoveParam::operator()()
    • ClosureMoveParam::operator()()
• Enums
  • ErrorMessage
  • expect()
  • ErrNo
  • SampleKind
  • EncodingPrefix
  • ConsolidationMode
  • Reliability
  • CongestionControl
  • Priority
  • QueryTarget
  • query_target_default()
  • WhatAmI
  • WhatAmI
    • WhatAmI::Z_WHATAMI_ROUTER
    • WhatAmI::Z_WHATAMI_PEER
    • WhatAmI::Z_WHATAMI_CLIENT
  • as_cstr()
• Generic types
  • BytesView
    • BytesView::BytesView()
    • BytesView::BytesView()
    • BytesView::BytesView()
    • BytesView::BytesView()
    • BytesView::BytesView()
    • BytesView::BytesView()
    • BytesView::as_string_view()
    • BytesView::operator==()
    • BytesView::operator!=()
    • BytesView::get_len()
    • BytesView::check()
  • Str
    • Str::c_str()
    • Str::operator const char*()
    • Str::operator==()
    • Str::operator==()
  • StrArrayView
  • _StrArrayView
    • _StrArrayView::_StrArrayView()
    • _StrArrayView::_StrArrayView()
    • _StrArrayView::_StrArrayView()
    • _StrArrayView::_StrArrayView()
    • _StrArrayView::operator[]()
    • _StrArrayView::get_len()
  • Encoding
    • Encoding::Encoding()
    • Encoding::Encoding()
    • Encoding::Encoding()
    • Encoding::set_prefix()
    • Encoding::set_suffix()
    • Encoding::get_prefix()
    • Encoding::get_suffix()
    • Encoding::operator==()
    • Encoding::operator!=()
  • Id
    • Id::is_some()
  • operator<<()
  • Timestamp
    • Timestamp::get_time()
    • Timestamp::get_id()
    • Timestamp::check()
  • Value
    • Value::Value()
    • Value::Value()
    • Value::Value()
    • Value::get_payload()
    • Value::set_payload()
    • Value::get_encoding()
    • Value::set_encoding()
    • Value::as_string_view()
    • Value::operator==()
    • Value::operator!=()
• Key Expressions
  • keyexpr_canonize()
  • keyexpr_canonize()
  • keyexpr_is_canon()
  • keyexpr_is_canon()
  • keyexpr_concat()
  • keyexpr_join()
  • keyexpr_equals()
  • keyexpr_equals()
  • keyexpr_includes()
  • keyexpr_includes()
  • keyexpr_intersects()
  • keyexpr_intersects()
  • KeyExprUnchecked
  • KeyExprView
    • KeyExprView::KeyExprView()
    • KeyExprView::KeyExprView()
    • KeyExprView::KeyExprView()
    • KeyExprView::KeyExprView()
    • KeyExprView::KeyExprView()
    • KeyExprView::KeyExprView()
    • KeyExprView::operator==()
    • KeyExprView::operator!=()
    • KeyExprView::check()
    • KeyExprView::as_bytes()
    • KeyExprView::as_string_view()
    • KeyExprView::resolve()
    • KeyExprView::concat()
    • KeyExprView::join()
    • KeyExprView::equals()
    • KeyExprView::includes()
    • KeyExprView::intersects()
    • KeyExprView::equals()
    • KeyExprView::includes()
    • KeyExprView::intersects()
  • KeyExpr
    • KeyExpr::KeyExpr()
    • KeyExpr::KeyExpr()
    • KeyExpr::as_keyexpr_view()
    • KeyExpr::as_bytes()
    • KeyExpr::as_string_view()
    • KeyExpr::operator zenoh::KeyExprView()
    • KeyExpr::operator==()
    • KeyExpr::concat()
    • KeyExpr::join()
    • KeyExpr::equals()
    • KeyExpr::includes()
    • KeyExpr::intersects()
    • KeyExpr::equals()
    • KeyExpr::includes()
    • KeyExpr::intersects()
• Configuration
  • Builder functions
    • config_peer()
    • config_from_file()
    • config_client()
    • config_client()
  • Configuration classes
    • Config
      • Config::Config()
      • Config::get()
      • Config::to_string()
      • Config::insert_json()
      • Config::get()
      • Config::insert()
      • Config::insert()
      • Config::create_scouting_config()
    • ScoutingConfig
      • ScoutingConfig::ScoutingConfig()
• Session
  • Builder function
    • open()
  • Utility functions
    • init_logger()
    • scout()
    • scout()
  • Session class
    • Session
      • Session::rcinc()
      • Session::info_zid()
      • Session::declare_keyexpr()
      • Session::undeclare_keyexpr()
      • Session::undeclare_keyexpr()
      • Session::get()
      • Session::get()
      • Session::get()
      • Session::get()
      • Session::put()
      • Session::put()
      • Session::put()
      • Session::put()
      • Session::delete_resource()
      • Session::delete_resource()
      • Session::delete_resource()
      • Session::delete_resource()
      • Session::put_owned()
      • Session::put_owned()
      • Session::put_owned()
      • Session::put_owned()
      • Session::declare_queryable()
      • Session::declare_queryable()
      • Session::declare_subscriber()
      • Session::declare_subscriber()
      • Session::declare_pull_subscriber()
      • Session::declare_pull_subscriber()
      • Session::declare_publisher()
      • Session::declare_publisher()
      • Session::info_routers_zid()
      • Session::info_routers_zid()
      • Session::info_peers_zid()
      • Session::info_peers_zid()
      • Session::start_read_task()
      • Session::start_read_task()
      • Session::stop_read_task()
      • Session::stop_read_task()
      • Session::start_lease_task()
      • Session::start_lease_task()
      • Session::stop_lease_task()
      • Session::stop_lease_task()
      • Session::read()
      • Session::read()
      • Session::send_keep_alive()
      • Session::send_keep_alive()
      • Session::send_join()
      • Session::send_join()
      • Session::keyexpr_concat()
      • Session::keyexpr_join()
      • Session::keyexpr_equals()
      • Session::keyexpr_equals()
      • Session::keyexpr_includes()
      • Session::keyexpr_includes()
      • Session::keyexpr_intersects()
      • Session::keyexpr_intersects()
• Entities
  • Publisher
    • Publisher::put()
    • Publisher::put()
    • Publisher::put()
    • Publisher::put()
    • Publisher::delete_resource()
    • Publisher::delete_resource()
    • Publisher::delete_resource()
    • Publisher::delete_resource()
    • Publisher::get_keyexpr()
    • Publisher::put_owned()
    • Publisher::put_owned()
    • Publisher::put_owned()
    • Publisher::put_owned()
  • Subscriber
  • PullSubscriber
    • PullSubscriber::pull()
    • PullSubscriber::pull()
  • Queryable
• Data
  • Hello
    • Hello::operator zenoh::HelloView()
  • HelloView
    • HelloView::get_id()
    • HelloView::get_whatami()
    • HelloView::get_locators()
  • Sample
    • Sample::get_keyexpr()
    • Sample::get_payload()
    • Sample::get_encoding()
    • Sample::get_kind()
    • Sample::get_qos()
    • Sample::get_timestamp()
    • Sample::sample_payload_rcinc()
    • Sample::get_attachment()
  • Query
    • Query::get_keyexpr()
    • Query::get_parameters()
    • Query::get_value()
    • Query::get_attachment()
    • Query::reply()
    • Query::reply()
    • Query::reply()
    • Query::reply()
  • Reply
    • Reply::is_ok()
    • Reply::get()
• Closures
  • ClosureReply
  • ClosureQuery
  • ClosureSample
  • ClosureZid
  • ClosureHello
  • ClosureReplyChannelSend
  • ClosureReplyChannelRecv
• Shared memory support
  • Payload
    • Payload::rcinc()
    • Payload::get_payload()
  • Shmbuf
    • Shmbuf::get_capacity()
    • Shmbuf::get_length()
    • Shmbuf::set_length()
    • Shmbuf::into_payload()
    • Shmbuf::ptr()
    • Shmbuf::char_ptr()
    • Shmbuf::as_string_view()
  • ShmManager
    • ShmManager::alloc()
    • ShmManager::defrag()
    • ShmManager::gc()
  • ShmManager::shm_manager_new()
• Options
  • QueryConsolidation
    • QueryConsolidation::QueryConsolidation()
    • QueryConsolidation::QueryConsolidation()
    • QueryConsolidation::set_mode()
    • QueryConsolidation::get_mode()
    • QueryConsolidation::operator==()
    • QueryConsolidation::operator!=()
  • GetOptions
    • GetOptions::GetOptions()
    • GetOptions::set_target()
    • GetOptions::set_consolidation()
    • GetOptions::set_value()
    • GetOptions::get_target()
    • GetOptions::get_consolidation()
    • GetOptions::get_value()
    • GetOptions::set_timeout_ms()
    • GetOptions::get_timeout_ms()
    • GetOptions::get_attachment()
    • GetOptions::set_attachment()
    • GetOptions::operator==()
    • GetOptions::operator!=()
  • PutOptions
    • PutOptions::PutOptions()
    • PutOptions::get_encoding()
    • PutOptions::set_encoding()
    • PutOptions::get_congestion_control()
    • PutOptions::set_congestion_control()
    • PutOptions::get_priority()
    • PutOptions::set_priority()
    • PutOptions::get_attachment()
    • PutOptions::set_attachment()
    • PutOptions::operator==()
    • PutOptions::operator!=()
  • DeleteOptions
    • DeleteOptions::DeleteOptions()
    • DeleteOptions::get_congestion_control()
    • DeleteOptions::set_congestion_control()
    • DeleteOptions::get_priority()
    • DeleteOptions::set_priority()
    • DeleteOptions::operator==()
    • DeleteOptions::operator!=()
  • QueryReplyOptions
    • QueryReplyOptions::QueryReplyOptions()
    • QueryReplyOptions::get_encoding()
    • QueryReplyOptions::set_encoding()
    • QueryReplyOptions::get_attachment()
    • QueryReplyOptions::set_attachment()
    • QueryReplyOptions::operator==()
    • QueryReplyOptions::operator!=()
  • QueryableOptions
    • QueryableOptions::QueryableOptions()
    • QueryableOptions::get_complete()
    • QueryableOptions::set_complete()
    • QueryableOptions::operator==()
    • QueryableOptions::operator!=()
  • SubscriberOptions
    • SubscriberOptions::SubscriberOptions()
    • SubscriberOptions::get_reliability()
    • SubscriberOptions::set_reliability()
    • SubscriberOptions::operator==()
    • SubscriberOptions::operator!=()
  • PullSubscriberOptions
    • PullSubscriberOptions::PullSubscriberOptions()
    • PullSubscriberOptions::get_reliability()
    • PullSubscriberOptions::set_reliability()
    • PullSubscriberOptions::operator==()
    • PullSubscriberOptions::operator!=()
  • PublisherOptions
    • PublisherOptions::PublisherOptions()
    • PublisherOptions::get_congestion_control()
    • PublisherOptions::set_congestion_control()
    • PublisherOptions::get_priority()
    • PublisherOptions::set_priority()
    • PublisherOptions::operator==()
    • PublisherOptions::operator!=()
  • PublisherPutOptions
    • PublisherPutOptions::PublisherPutOptions()
    • PublisherPutOptions::get_encoding()
    • PublisherPutOptions::set_encoding()
    • PublisherPutOptions::get_attachment()
    • PublisherPutOptions::set_attachment()
    • PublisherPutOptions::operator==()
    • PublisherPutOptions::operator!=()
  • PublisherDeleteOptions
    • PublisherDeleteOptions::operator==()
    • PublisherDeleteOptions::operator!=()
• Channels
  • reply_fifo_new()
  • reply_non_blocking_fifo_new()