Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

prefix doc update #761

Merged
merged 4 commits into from
Oct 14, 2024
Merged

prefix doc update #761

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f23363
prefix doc update
milyin Oct 14, 2024
7e50736
Merge branch 'main' into prefixes_doc
milyin Oct 14, 2024
2ae9323
exchanged ze and zc/p
milyin Oct 14, 2024
269e70b
minor corrections
milyin Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions docs/concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,21 @@ Types named `z_xxx_t` are copyable, and can be passed by value. Some of them are
Name Prefixes `z_`, `zc_`, `ze_`
================================

Most functions and types in the C API use the `z_` prefix, which applies to the common zenoh C API
(currently Rust-based zenoh-c and pure C zenoh-pico).
We try to maintain a common API between `zenoh-c` and `zenoh-pico`, such that porting code from one to the other is, ideally, trivial.
However, due design limitations some functionality might be represented differently (or simply be not available) in either library.
The `zc_` prefix is used for functions/structs specific to `zenoh-c`. `zenoh-pico` uses the `zp_` prefix for the same purpose.
However, due to design limitations some functionality might be represented differently (or simply be not available) in either library.

The namespace prefixes are used to distinguish between different parts of the API.

The `ze_` prefix identifies functions and types from the `zenoh-ext` Rust library that are not
part of the core Zenoh API and therefore are placed in a separate namespace. Note, that this functionality might not
be fully available in `zenoh-pico`.
Most functions and types in the C API use the `z_` prefix, which applies to the core Zenoh API.
These functions and types are guaranteed to be available in all Zenoh implementations on C
(currently, Rust-based zenoh-c and pure C zenoh-pico).

The `zc_` prefix identifies API specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose.
milyin marked this conversation as resolved.
Show resolved Hide resolved
E.g. zenoh-c and zenoh-pico have different approaches to configuration and therefore each have their own set
of `zc_config_...` and `zp_config_...` functions.

The `ze_` prefix is used for the API that is not part of the core zenoh API. There is no guarantee that
these functions and types are available for both implementations. However, when they are provided for both, they should
have the same prototype and behavior. Typically, these are functions and types provided by the `zenoh-ext` Rust library
for zenoh-c and are not available in zenoh-pico. However, the data serialization API is implemented in zenoh-pico with
the same `ze_` prefix.