Skip to content

Commit

Permalink
clarify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DenisBiryukov91 committed Jan 15, 2025
1 parent c7319b5 commit 4672e5f
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion include/zenoh_commons.h
Original file line number Diff line number Diff line change
Expand Up @@ -1059,6 +1059,7 @@ typedef struct ze_advanced_publisher_sample_miss_detection_options_t {
/**
* If different from zero, the publisher will send heartbeats with the specified period, which
* can be used by Advanced Subscribers for missed sample detection (if recovery with zero query period is enabled).
* Otherwise, missed samples will be retransmitted based on Advanced Subscribers periodic queries.
*/
uint64_t heartbeat_period_ms;
} ze_advanced_publisher_sample_miss_detection_options_t;
Expand Down Expand Up @@ -1200,7 +1201,6 @@ typedef struct ze_advanced_subscriber_recovery_options_t {
* So it is useful for sporadic publications but useless for periodic publications
* with a period smaller or equal to this period. If set to 0, the missed samples will be retrieved
* based on publisher's heartbeat.
* Retransmission can only be achieved by Publishers that also activate retransmission (and heartbeat if periodic_queries_period_ms is 0).
*/
uint64_t periodic_queries_period_ms;
} ze_advanced_subscriber_recovery_options_t;
Expand Down
1 change: 1 addition & 0 deletions src/advanced_publisher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ pub struct ze_advanced_publisher_sample_miss_detection_options_t {
pub is_enabled: bool,
/// If different from zero, the publisher will send heartbeats with the specified period, which
/// can be used by Advanced Subscribers for missed sample detection (if recovery with zero query period is enabled).
/// Otherwise, missed samples will be retransmitted based on Advanced Subscribers periodic queries.
pub heartbeat_period_ms: u64,
}

Expand Down
1 change: 0 additions & 1 deletion src/advanced_subscriber.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ pub struct ze_advanced_subscriber_recovery_options_t {
/// So it is useful for sporadic publications but useless for periodic publications
/// with a period smaller or equal to this period. If set to 0, the missed samples will be retrieved
/// based on publisher's heartbeat.
/// Retransmission can only be achieved by Publishers that also activate retransmission (and heartbeat if periodic_queries_period_ms is 0).
pub periodic_queries_period_ms: u64,
}

Expand Down

0 comments on commit 4672e5f

Please sign in to comment.