Skip to content

Commit 9f7b876

Browse files
committed
minor docs improvement
1 parent 21cb8a1 commit 9f7b876

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

include/libcyphal/transport/session.hpp

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,14 @@ class IRxSession : public ISession
4848

4949
/// @brief Sets the timeout for a transmission.
5050
///
51+
/// Note that b/c of the nature of the Lizard libraries, the timeout is shared
52+
/// between different sessions of the same kind and port id. This means that
53+
/// the timeout set for one session will affect all other sessions of the same kind and port id.
54+
/// For example, two RPC clients (on the same service id) of two different RPC server nodes
55+
/// will share the same timeout for transfer ids.
5156
/// See Cyphal specification about transfer-ID timeouts.
5257
///
53-
/// @param timeout - Positive duration for the timeout. Default value is 2 second.
58+
/// @param timeout - Positive duration for the timeout. The default value is 2 seconds.
5459
/// Zero or negative values are ignored.
5560
///
5661
virtual void setTransferIdTimeout(const Duration timeout) = 0;

0 commit comments

Comments
 (0)