@@ -203,34 +203,34 @@ class AdvancedSubscriber(Generic[_H]):
203203@_unstable
204204@final
205205class CacheConfig :
206+ """
207+ :param max_samples: specify how many samples to keep for each resource, default to 1
208+ :param replies_config: the QoS to apply to replies
209+ """
206210 def __new__ (
207211 cls ,
208212 max_samples : int | None = None ,
209213 * ,
210214 replies_config : RepliesConfig | None = None ,
211- ) -> Self :
212- """
213- :param max_samples: specify how many samples to keep for each resource, default to 1
214- :param replies_config: the QoS to apply to replies
215- """
215+ ) -> Self : ...
216216
217217@_unstable
218218@final
219219class HistoryConfig :
220+ """
221+ :param detect_late_publishers: enable detection of late joiner publishers and query for their historical data;
222+ late joiner detection can only be achieved for `AdvancedPublisher` that enable `publisher_detection`
223+ history can only be retransmitted by `AdvancedPublisher` that enable `cache`
224+ :param max_samples: specify how many samples to query for each resource
225+ :param max_age: specify the maximum age of samples to query in seconds
226+ """
220227 def __new__ (
221228 cls ,
222229 * ,
223230 detect_late_publishers : bool | None = None ,
224231 max_samples : int | None = None ,
225232 max_age : float | int | None = None ,
226- ) -> Self :
227- """
228- :param detect_late_publishers: enable detection of late joiner publishers and query for their historical data;
229- late joiner detection can only be achieved for `AdvancedPublisher` that enable `publisher_detection`
230- history can only be retransmitted by `AdvancedPublisher` that enable `cache`
231- :param max_samples: specify how many samples to query for each resource
232- :param max_age: specify the maximum age of samples to query in seconds
233- """
233+ ) -> Self : ...
234234
235235@_unstable
236236@final
@@ -246,42 +246,46 @@ class Miss:
246246@_unstable
247247@final
248248class MissDetectionConfig :
249+ """
250+ :param heartbeat: period in seconds, allow last sample miss detection through periodic heartbeat;
251+ periodically send the last published Sample's sequence number to allow last sample recovery.
252+ `AdvancedSubscriber can only recover the last sample with the `heartbeat` option enabled.
253+
254+ **This option can not be enabled simultaneously with `sporadic_heartbeat`.**
255+
256+ :param sporadic_heartbeat: period in seconds, allow last sample miss detection through sporadic heartbeat;
257+ each period, the last published Sample's sequence number is sent with `CongestionControl.Block` but only if
258+ it has changed since the last period.
259+ `AdvancedSubscriber can only recover the last sample with the `heartbeat` option enabled.
260+
261+ **This option can not be enabled simultaneously with `heartbeat`.**
262+ """
249263 def __new__ (
250264 cls , * , heartbeat : float | int | None , sporadic_heartbeat : float | int | None
251- ) -> Self :
252- """
253- :param heartbeat: period in seconds, allow last sample miss detection through periodic heartbeat;
254- periodically send the last published Sample's sequence number to allow last sample recovery.
255- `AdvancedSubscriber can only recover the last sample with the `heartbeat` option enabled.
256- This option can not be enabled simultaneously with `sporadic_heartbeat`.
257-
258- :param sporadic_heartbeat: period in seconds, allow last sample miss detection through sporadic heartbeat;
259- each period, the last published Sample's sequence number is sent with `CongestionControl.Block` but only if
260- it has changed since the last period.
261- `AdvancedSubscriber can only recover the last sample with the `heartbeat` option enabled.
262- This option can not be enabled simultaneously with `heartbeat`.
263- """
265+ ) -> Self : ...
264266
265267@_unstable
266268@final
267269class RecoveryConfig :
270+ """
271+ :param periodic_queries: enable periodic queries for not yet received Samples and specify their period;
272+ it allows retrieving the last Sample(s) if the last Sample(s) is/are lost,
273+ so it is useful for sporadic publications but useless for periodic publications
274+ with a period smaller or equal to this period.
275+ Retransmission can only be achieved by `AdvancedPublisher` that enable `cache` and `sample_miss_detection`.
276+
277+ **This option can not be enabled simultaneously with `heartbeat`.**
278+
279+ :param heartbeat: subscribe to heartbeats of `AdvancedPublisher`;
280+ it allows receiving the last published Sample's sequence number and check for misses.
281+ Heartbeat subscriber must be paired with `AdvancedPublishers` that enable `cache` and
282+ `sample_miss_detection` with `heartbeat` or `sporadic_heartbeat`.
283+
284+ **This option can not be enabled simultaneously with `periodic_queries`.**
285+ """
268286 def __new__ (
269287 cls , * , periodic_queries : float | int | None , heartbeat : Literal [True ] | None
270- ) -> Self :
271- """
272- :param periodic_queries: enable periodic queries for not yet received Samples and specify their period;
273- it allows retrieving the last Sample(s) if the last Sample(s) is/are lost,
274- so it is useful for sporadic publications but useless for periodic publications
275- with a period smaller or equal to this period.
276- Retransmission can only be achieved by `AdvancedPublisher` that enable `cache` and `sample_miss_detection`.
277- This option can not be enabled simultaneously with `heartbeat`.
278-
279- :param heartbeat: subscribe to heartbeats of `AdvancedPublisher`;
280- it allows receiving the last published Sample's sequence number and check for misses.
281- Heartbeat subscriber must be paired with `AdvancedPublishers` that enable `cache` and
282- `sample_miss_detection` with `heartbeat` or `sporadic_heartbeat`.
283- This option can not be enabled simultaneously with `periodic_queries`.
284- """
288+ ) -> Self : ...
285289
286290@_unstable
287291@final
0 commit comments