@@ -203,34 +203,36 @@ 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+ """
210+
206211 def __new__ (
207212 cls ,
208213 max_samples : int | None = None ,
209214 * ,
210215 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- """
216+ ) -> Self : ...
216217
217218@_unstable
218219@final
219220class HistoryConfig :
221+ """
222+ :param detect_late_publishers: enable detection of late joiner publishers and query for their historical data;
223+ late joiner detection can only be achieved for `AdvancedPublisher` that enable `publisher_detection`
224+ history can only be retransmitted by `AdvancedPublisher` that enable `cache`
225+ :param max_samples: specify how many samples to query for each resource
226+ :param max_age: specify the maximum age of samples to query in seconds
227+ """
228+
220229 def __new__ (
221230 cls ,
222231 * ,
223232 detect_late_publishers : bool | None = None ,
224233 max_samples : int | None = None ,
225234 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- """
235+ ) -> Self : ...
234236
235237@_unstable
236238@final
@@ -246,42 +248,48 @@ class Miss:
246248@_unstable
247249@final
248250class MissDetectionConfig :
251+ """
252+ :param heartbeat: period in seconds, allow last sample miss detection through periodic heartbeat;
253+ periodically send the last published Sample's sequence number to allow last sample recovery.
254+ `AdvancedSubscriber can only recover the last sample with the `heartbeat` option enabled.
255+
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+
263+ **This option can not be enabled simultaneously with `heartbeat`.**
264+ """
265+
249266 def __new__ (
250267 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- """
268+ ) -> Self : ...
264269
265270@_unstable
266271@final
267272class RecoveryConfig :
273+ """
274+ :param periodic_queries: enable periodic queries for not yet received Samples and specify their period;
275+ it allows retrieving the last Sample(s) if the last Sample(s) is/are lost,
276+ so it is useful for sporadic publications but useless for periodic publications
277+ with a period smaller or equal to this period.
278+ Retransmission can only be achieved by `AdvancedPublisher` that enable `cache` and `sample_miss_detection`.
279+
280+ **This option can not be enabled simultaneously with `heartbeat`.**
281+
282+ :param heartbeat: subscribe to heartbeats of `AdvancedPublisher`;
283+ it allows receiving the last published Sample's sequence number and check for misses.
284+ Heartbeat subscriber must be paired with `AdvancedPublishers` that enable `cache` and
285+ `sample_miss_detection` with `heartbeat` or `sporadic_heartbeat`.
286+
287+ **This option can not be enabled simultaneously with `periodic_queries`.**
288+ """
289+
268290 def __new__ (
269291 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- """
292+ ) -> Self : ...
285293
286294@_unstable
287295@final
0 commit comments