Skip to content

Commit

Permalink
Minor docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
serges147 committed May 14, 2024
1 parent feded23 commit 0c5f0e1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions include/libcyphal/transport/transport.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -65,37 +65,37 @@ class ITransport : public IRunnable

/// @brief Makes a message receive (RX) session.
///
/// Lifetime of the RX session must never outlive this transport interface.
/// The RX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IMessageRxSession>, AnyError> makeMessageRxSession(const MessageRxParams& params) = 0;

/// @brief Makes a message transmit (TX) session.
///
/// Lifetime of the TX session must never outlive this transport interface.
/// The TX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IMessageTxSession>, AnyError> makeMessageTxSession(const MessageTxParams& params) = 0;

/// @brief Makes a service request receive (RX) session.
///
/// Lifetime of the RX session must never outlive this transport interface.
/// The RX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IRequestRxSession>, AnyError> makeRequestRxSession(const RequestRxParams& params) = 0;

/// @brief Makes a service request transmit (TX) session.
///
/// Lifetime of the TX session must never outlive this transport interface.
/// The TX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IRequestTxSession>, AnyError> makeRequestTxSession(const RequestTxParams& params) = 0;

/// @brief Makes a service response receive (RX) session.
///
/// Lifetime of the RX session must never outlive this transport interface.
/// The RX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IResponseRxSession>, AnyError> makeResponseRxSession(const ResponseRxParams& params) = 0;

/// @brief Makes a service response transmit (TX) session.
///
/// Lifetime of the TX session must never outlive this transport interface.
/// The TX session must never outlive this transport interface.
///
virtual Expected<UniquePtr<IResponseTxSession>, AnyError> makeResponseTxSession(const ResponseTxParams& params) = 0;

Expand Down

0 comments on commit 0c5f0e1

Please sign in to comment.