Skip to content

Commit

Permalink
Merge commit 'ecad7f358fabdf55c4d6c35118415b5c457c8f20'
Browse files Browse the repository at this point in the history 
Conflicts:
	include/zenoh_commons.h
	src/shm/buffer/zshmmut.rs
  • Loading branch information
@yellowhatter
yellowhatter committed Sep 10, 2024
2 parents 3febfb9 + ecad7f3 commit db1ee5e
Show file tree
Hide file tree
Showing 33 changed files with 1,189 additions and 837 deletions.
777 changes: 341 additions & 436 deletions Cargo.lock
View file

Large diffs are not rendered by default.

81 changes: 54 additions & 27 deletions build-resources/opaque-types/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ get_opaque_type_data!(Option<Queryable<'static, ()>>, z_owned_queryable_t);
/// A loaned Zenoh queryable.
get_opaque_type_data!(Queryable<'static, ()>, z_loaned_queryable_t);
#[cfg(feature = "unstable")]
/// An owned Zenoh querying subscriber.
/// @attention Unstable feature.
/// @brief An owned Zenoh querying subscriber.
///
/// In addition to receiving the data it is subscribed to,
/// it also will fetch data from a Queryable at startup and peridodically (using `ze_querying_subscriber_get()`).
Expand All @@ -140,7 +141,8 @@ get_opaque_type_data!(
ze_owned_querying_subscriber_t
);
#[cfg(feature = "unstable")]
/// A loaned Zenoh querying subscriber.
/// @attention Unstable feature.
/// @brief A loaned Zenoh querying subscriber.
get_opaque_type_data!(
(zenoh_ext::FetchingSubscriber<'static, ()>, &'static Session),
ze_loaned_querying_subscriber_t
Expand Down Expand Up @@ -188,7 +190,8 @@ get_opaque_type_data!(Option<Config>, z_owned_config_t);
get_opaque_type_data!(Config, z_loaned_config_t);

#[cfg(feature = "unstable")]
/// A Zenoh ID.
/// @attention Unstable feature.
/// @brief A Zenoh ID.
///
/// In general, valid Zenoh IDs are LSB-first 128bit unsigned and non-zero integers.
get_opaque_type_data!(ZenohId, z_id_t);
Expand All @@ -204,7 +207,8 @@ get_opaque_type_data!(Option<Publisher<'static>>, z_owned_publisher_t);
get_opaque_type_data!(Publisher<'static>, z_loaned_publisher_t);

#[cfg(feature = "unstable")]
/// An owned Zenoh matching listener.
/// @attention Unstable feature.
/// @brief An owned Zenoh matching listener.
///
/// A listener that sends notifications when the [`MatchingStatus`] of a publisher changes.
/// Dropping the corresponding publisher, also drops matching listener.
Expand All @@ -222,7 +226,8 @@ get_opaque_type_data!(Option<Subscriber<'static, ()>>, z_owned_subscriber_t);
get_opaque_type_data!(Subscriber<'static, ()>, z_loaned_subscriber_t);

#[cfg(feature = "unstable")]
/// A liveliness token that can be used to provide the network with information about connectivity to its
/// @attention Unstable feature.
/// @brief A liveliness token that can be used to provide the network with information about connectivity to its
/// declarer: when constructed, a PUT sample will be received by liveliness subscribers on intersecting key
/// expressions.
///
Expand All @@ -232,9 +237,11 @@ get_opaque_type_data!(
zc_owned_liveliness_token_t
);
#[cfg(feature = "unstable")]
/// @attention Unstable feature.
get_opaque_type_data!(LivelinessToken<'static>, zc_loaned_liveliness_token_t);
#[cfg(feature = "unstable")]
/// An owned Zenoh publication cache.
/// @attention Unstable feature.
/// @brief An owned Zenoh publication cache.
///
/// Used to store publications on intersecting key expressions. Can be queried later via `z_get()` to retrieve this data
/// (for example by `ze_owned_querying_subscriber_t`).
Expand All @@ -243,7 +250,8 @@ get_opaque_type_data!(
ze_owned_publication_cache_t
);
#[cfg(feature = "unstable")]
/// A loaned Zenoh publication cache.
/// @attention Unstable feature.
/// @brief A loaned Zenoh publication cache.
get_opaque_type_data!(
zenoh_ext::PublicationCache<'static>,
ze_loaned_publication_cache_t
Expand Down Expand Up @@ -276,54 +284,66 @@ get_opaque_type_data!(Option<Hello>, z_owned_hello_t);
get_opaque_type_data!(Hello, z_loaned_hello_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned SHM Client
/// @attention Unstable feature.
/// @brief An owned SHM Client.
get_opaque_type_data!(Option<Arc<dyn ShmClient>>, z_owned_shm_client_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned list of SHM Clients
/// @attention Unstable feature.
/// @brief An owned list of SHM Clients.
get_opaque_type_data!(
Option<Vec<(ProtocolID, Arc<dyn ShmClient>)>>,
zc_owned_shm_client_list_t
);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned list of SHM Clients
/// @attention Unstable feature.
/// @brief A loaned list of SHM Clients.
get_opaque_type_data!(
Vec<(ProtocolID, Arc<dyn ShmClient>)>,
zc_loaned_shm_client_list_t
);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned SHM Client Storage
/// @attention Unstable feature.
/// @brief An owned SHM Client Storage
get_opaque_type_data!(Option<Arc<ShmClientStorage>>, z_owned_shm_client_storage_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned SHM Client Storage
/// A loaned SHM Client Storage.
get_opaque_type_data!(Arc<ShmClientStorage>, z_loaned_shm_client_storage_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned MemoryLayout
/// @attention Unstable feature.
/// @brief An owned MemoryLayout.
get_opaque_type_data!(Option<MemoryLayout>, z_owned_memory_layout_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned MemoryLayout
/// @attention Unstable feature.
/// @brief A loaned MemoryLayout.
get_opaque_type_data!(MemoryLayout, z_loaned_memory_layout_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned ChunkAllocResult
/// @attention Unstable feature.
/// @brief An owned ChunkAllocResult.
get_opaque_type_data!(Option<ChunkAllocResult>, z_owned_chunk_alloc_result_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned ChunkAllocResult
/// @attention Unstable feature.
/// @brief A loaned ChunkAllocResult.
get_opaque_type_data!(ChunkAllocResult, z_loaned_chunk_alloc_result_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned ZShm slice
/// @attention Unstable feature.
/// @brief An owned ZShm slice.
get_opaque_type_data!(Option<ZShm>, z_owned_shm_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned ZShm slice
/// @attention Unstable feature.
/// @brief A loaned ZShm slice.
get_opaque_type_data!(zshm, z_loaned_shm_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned ZShmMut slice
/// @attention Unstable feature.
/// @brief An owned ZShmMut slice.
get_opaque_type_data!(Option<ZShmMut>, z_owned_shm_mut_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned ZShmMut slice
/// @attention Unstable feature.
/// @brief A loaned ZShmMut slice.
get_opaque_type_data!(zshmmut, z_loaned_shm_mut_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
Expand Down Expand Up @@ -388,10 +408,12 @@ enum CDummySHMProvider {
}

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned ShmProvider
/// @attention Unstable feature.
/// @brief An owned ShmProvider.
get_opaque_type_data!(Option<CDummySHMProvider>, z_owned_shm_provider_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned ShmProvider
/// @attention Unstable feature.
/// @brief A loaned ShmProvider.
get_opaque_type_data!(CDummySHMProvider, z_loaned_shm_provider_t);

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
Expand All @@ -408,10 +430,12 @@ enum CSHMLayout {
}

#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// An owned ShmProvider's AllocLayout
/// @attention Unstable feature.
/// @brief An owned ShmProvider's AllocLayout.
get_opaque_type_data!(Option<CSHMLayout>, z_owned_alloc_layout_t);
#[cfg(all(feature = "shared-memory", feature = "unstable"))]
/// A loaned ShmProvider's AllocLayout
/// @attention Unstable feature.
/// @brief A loaned ShmProvider's AllocLayout.
get_opaque_type_data!(CSHMLayout, z_loaned_alloc_layout_t);

/// An owned Zenoh fifo sample handler.
Expand Down Expand Up @@ -457,11 +481,14 @@ get_opaque_type_data!(
get_opaque_type_data!(RingChannelHandler<Reply>, z_loaned_ring_handler_reply_t);

#[cfg(feature = "unstable")]
/// An owned Zenoh-allocated source info`.
/// @attention Unstable feature.
/// @brief An owned Zenoh-allocated source info`.
get_opaque_type_data!(SourceInfo, z_owned_source_info_t);
#[cfg(feature = "unstable")]
/// A loaned source info.
/// @attention Unstable feature.
/// @brief A loaned source info.
get_opaque_type_data!(SourceInfo, z_loaned_source_info_t);
#[cfg(feature = "unstable")]
/// An entity gloabal id.
/// @attention Unstable feature.
/// @brief An entity gloabal id.
get_opaque_type_data!(EntityGlobalId, z_entity_global_id_t);
2 changes: 0 additions & 2 deletions docs/api.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -534,8 +534,6 @@ Functions

.. doxygenfunction:: z_reliability_default

.. doxygenfunction:: zc_closure_matching_status_check
.. doxygenfunction:: zc_closure_matching_status_null
.. doxygenfunction:: zc_closure_matching_status_drop
.. doxygenfunction:: zc_closure_matching_status_call

Expand Down
Loading

0 comments on commit db1ee5e

Please sign in to comment.