diff --git a/include/fastdds/dds/core/policy/QosPolicies.hpp b/include/fastdds/dds/core/policy/QosPolicies.hpp index 3b0bc1569ed..0d14046dfc8 100644 --- a/include/fastdds/dds/core/policy/QosPolicies.hpp +++ b/include/fastdds/dds/core/policy/QosPolicies.hpp @@ -2785,6 +2785,22 @@ class TransportConfigQos : public QosPolicy * By default, 0. */ uint32_t listen_socket_buffer_size; +<<<<<<< HEAD +======= + + //! Thread settings for the builtin transports reception threads + rtps::ThreadSettings builtin_transports_reception_threads_; + + /*! + * @brief Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA. + * If this value is not zero, the network factory will allow the initialization of UDP transports with maxMessageSize + * higher than 65500K. + */ + uint32_t max_msg_size_no_frag; + + //! Netmask filter configuration + fastdds::rtps::NetmaskFilterKind netmask_filter; +>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016)) }; //! Qos Policy to configure the endpoint diff --git a/include/fastdds/dds/domain/DomainParticipant.hpp b/include/fastdds/dds/domain/DomainParticipant.hpp index 7ac5f4b8998..564c3f6b89f 100644 --- a/include/fastdds/dds/domain/DomainParticipant.hpp +++ b/include/fastdds/dds/domain/DomainParticipant.hpp @@ -673,6 +673,7 @@ class DomainParticipant : public Entity * * @param[out] participant_handles Reference to the vector where discovered participants will be returned * @return RETCODE_OK if everything correct, error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_discovered_participants( @@ -684,6 +685,7 @@ class DomainParticipant : public Entity * @param[out] participant_data Reference to the ParticipantBuiltinTopicData object to return the data * @param participant_handle InstanceHandle of DomainParticipant to retrieve the data from * @return RETCODE_OK if everything correct, PRECONDITION_NOT_MET if participant does not exist + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_discovered_participant_data( @@ -695,6 +697,7 @@ class DomainParticipant : public Entity * * @param[out] topic_handles Reference to the vector where discovered topics will be returned * @return RETCODE_OK if everything correct, error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_discovered_topics( diff --git a/include/fastdds/dds/domain/DomainParticipantFactory.hpp b/include/fastdds/dds/domain/DomainParticipantFactory.hpp index 6dabef3ecdb..ca0a00e39b0 100644 --- a/include/fastdds/dds/domain/DomainParticipantFactory.hpp +++ b/include/fastdds/dds/domain/DomainParticipantFactory.hpp @@ -139,7 +139,7 @@ class DomainParticipantFactory * Returns all participants that belongs to the specified domain_id. * * @param domain_id - * @return previously created DomainParticipants within the specified domain + * @return previously created DomainParticipant instances within the specified domain */ RTPS_DllAPI std::vector lookup_participants( DomainId_t domain_id) const; diff --git a/include/fastdds/dds/domain/DomainParticipantListener.hpp b/include/fastdds/dds/domain/DomainParticipantListener.hpp index 012ea3415e5..4cc1627f7fe 100644 --- a/include/fastdds/dds/domain/DomainParticipantListener.hpp +++ b/include/fastdds/dds/domain/DomainParticipantListener.hpp @@ -186,9 +186,7 @@ class DomainParticipantListener : /*! * This method is called when a participant discovers a new Type * The ownership of all object belongs to the caller so if needs to be used after the - * method ends, a full copy should be perform (except for dyn_type due to its shared_ptr nature. - * For example: - * fastrtps::types::TypeIdentifier new_type_id = \*identifier; + * method ends, a full copy should be performed (except for dyn_type due to its shared_ptr nature). */ virtual void on_type_discovery( DomainParticipant* participant, diff --git a/include/fastdds/dds/publisher/DataWriter.hpp b/include/fastdds/dds/publisher/DataWriter.hpp index 239e9ee5851..ef0b261c9a5 100644 --- a/include/fastdds/dds/publisher/DataWriter.hpp +++ b/include/fastdds/dds/publisher/DataWriter.hpp @@ -514,6 +514,7 @@ class DataWriter : public DomainEntity * @param[out] subscription_data subscription data struct * @param subscription_handle InstanceHandle_t of the subscription * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_matched_subscription_data( @@ -525,6 +526,7 @@ class DataWriter : public DomainEntity * * @param[out] subscription_handles Vector where the InstanceHandle_t are returned * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_matched_subscriptions( diff --git a/include/fastdds/dds/publisher/Publisher.hpp b/include/fastdds/dds/publisher/Publisher.hpp index a1423b40a9c..2c6119cdd10 100644 --- a/include/fastdds/dds/publisher/Publisher.hpp +++ b/include/fastdds/dds/publisher/Publisher.hpp @@ -247,6 +247,7 @@ class Publisher : public DomainEntity * @brief Indicates to FastDDS that the contained DataWriters are about to be modified * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t suspend_publications(); @@ -255,6 +256,7 @@ class Publisher : public DomainEntity * @brief Indicates to FastDDS that the modifications to the DataWriters are complete. * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t resume_publications(); @@ -263,6 +265,7 @@ class Publisher : public DomainEntity * @brief Signals the beginning of a set of coherent cache changes using the Datawriters attached to the publisher * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t begin_coherent_changes(); @@ -271,6 +274,7 @@ class Publisher : public DomainEntity * @brief Signals the end of a set of coherent cache changes * * @return RETCODE_OK if successful, an error code otherwise + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t end_coherent_changes(); @@ -352,6 +356,10 @@ class Publisher : public DomainEntity * @param[out] writer_qos * @param[in] topic_qos * @return RETCODE_OK if successful, an error code otherwise +<<<<<<< HEAD +======= + * +>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016)) * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t copy_from_topic_qos( diff --git a/include/fastdds/dds/subscriber/DataReader.hpp b/include/fastdds/dds/subscriber/DataReader.hpp index 61846b6a91b..ecdc9c29973 100644 --- a/include/fastdds/dds/subscriber/DataReader.hpp +++ b/include/fastdds/dds/subscriber/DataReader.hpp @@ -136,6 +136,7 @@ class DataReader : public DomainEntity * * @param[in] max_wait Max blocking time for this operation. * @return RETCODE_OK if there is new unread message, ReturnCode_t::RETCODE_TIMEOUT if timeout + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t wait_for_historical_data( @@ -764,6 +765,7 @@ class DataReader : public DomainEntity * @param[in] handle * * @return Any of the standard return codes. + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_key_value( @@ -976,6 +978,7 @@ class DataReader : public DomainEntity * @param[out] publication_data publication data struct * @param publication_handle InstanceHandle_t of the publication * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_matched_publication_data( @@ -987,6 +990,7 @@ class DataReader : public DomainEntity * * @param[out] publication_handles Vector where the InstanceHandle_t are returned * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_matched_publications( diff --git a/include/fastdds/dds/subscriber/Subscriber.hpp b/include/fastdds/dds/subscriber/Subscriber.hpp index bb5b78c5d4c..f06bfa25aa3 100644 --- a/include/fastdds/dds/subscriber/Subscriber.hpp +++ b/include/fastdds/dds/subscriber/Subscriber.hpp @@ -264,6 +264,7 @@ class Subscriber : public DomainEntity * @param view_states Vector of ViewStateKind * @param instance_states Vector of InstanceStateKind * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t get_datareaders( @@ -284,6 +285,7 @@ class Subscriber : public DomainEntity * attached to the Subscriber. * * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t begin_access(); @@ -293,6 +295,7 @@ class Subscriber : public DomainEntity * the Subscriber. * * @return RETCODE_OK + * * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI ReturnCode_t end_access(); @@ -390,6 +393,10 @@ class Subscriber : public DomainEntity * @param[in, out] reader_qos * @param[in] topic_qos * @return RETCODE_OK if successful, an error code otherwise +<<<<<<< HEAD +======= + * +>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016)) * @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED */ RTPS_DllAPI static ReturnCode_t copy_from_topic_qos( diff --git a/include/fastdds/rtps/common/ChangeKind_t.hpp b/include/fastdds/rtps/common/ChangeKind_t.hpp index 5ffbceb385b..42a180ddef5 100644 --- a/include/fastdds/rtps/common/ChangeKind_t.hpp +++ b/include/fastdds/rtps/common/ChangeKind_t.hpp @@ -26,8 +26,7 @@ namespace fastrtps { namespace rtps { /** - * @enum ChangeKind_t, different types of CacheChange_t. - * @ingroup COMMON_MODULE + * Enumerates the different types of CacheChange_t. */ enum RTPS_DllAPI ChangeKind_t { diff --git a/include/fastdds/rtps/common/FragmentNumber.h b/include/fastdds/rtps/common/FragmentNumber.h index a1b5d1dcef0..909cedac172 100644 --- a/include/fastdds/rtps/common/FragmentNumber.h +++ b/include/fastdds/rtps/common/FragmentNumber.h @@ -19,37 +19,38 @@ #ifndef _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_ #define _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_ +#include +#include +#include + +#include #include #include -#include -#include -#include -#include - -namespace eprosima{ -namespace fastrtps{ -namespace rtps{ +namespace eprosima { +namespace fastrtps { +namespace rtps { using FragmentNumber_t = uint32_t; //!Structure FragmentNumberSet_t, contains a group of fragmentnumbers. -//!@ingroup COMMON_MODULE using FragmentNumberSet_t = BitmapRange; -inline std::ostream& operator<<(std::ostream& output, const FragmentNumberSet_t& fns) +inline std::ostream& operator <<( + std::ostream& output, + const FragmentNumberSet_t& fns) { output << fns.base() << ":"; fns.for_each([&](FragmentNumber_t it) - { - output << it << "-"; - }); + { + output << it << "-"; + }); return output; } -} -} -} +} // namespace rtps +} // namespace fastrtps +} // namespace eprosima #endif /* _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_ */ diff --git a/include/fastdds/rtps/common/MatchingInfo.h b/include/fastdds/rtps/common/MatchingInfo.h index f572b44f2b6..cb7a51c9308 100644 --- a/include/fastdds/rtps/common/MatchingInfo.h +++ b/include/fastdds/rtps/common/MatchingInfo.h @@ -22,22 +22,23 @@ #include -namespace eprosima{ -namespace fastrtps{ -namespace rtps{ +namespace eprosima { +namespace fastrtps { +namespace rtps { /** - * @enum MatchingStatus, indicates whether the matched publication/subscription method of the PublisherListener or SubscriberListener has + * Indicates whether the matched publication/subscription method of the PublisherListener or SubscriberListener has * been called for a matching or a removal of a remote endpoint. - * @ingroup COMMON_MODULE */ #if defined(_WIN32) - enum RTPS_DllAPI MatchingStatus{ +enum RTPS_DllAPI MatchingStatus +{ #else - enum MatchingStatus{ -#endif - MATCHED_MATCHING,//!< MATCHED_MATCHING, new publisher/subscriber found - REMOVED_MATCHING //!< REMOVED_MATCHING, publisher/subscriber removed +enum MatchingStatus +{ +#endif // if defined(_WIN32) + MATCHED_MATCHING, //!< MATCHED_MATCHING, new publisher/subscriber found + REMOVED_MATCHING //!< REMOVED_MATCHING, publisher/subscriber removed }; @@ -48,21 +49,36 @@ namespace rtps{ class RTPS_DllAPI MatchingInfo { public: - //!Default constructor - MatchingInfo():status(MATCHED_MATCHING){}; + + //! Default constructor + MatchingInfo() + : status(MATCHED_MATCHING) + { + } + /** - * @param stat Status - * @param guid GUID - */ - MatchingInfo(MatchingStatus stat,const GUID_t&guid):status(stat),remoteEndpointGuid(guid){}; - ~MatchingInfo(){}; - //!Status + * @param stat Status + * @param guid GUID + */ + MatchingInfo( + MatchingStatus stat, + const GUID_t& guid) + : status(stat) + , remoteEndpointGuid(guid) + { + } + + ~MatchingInfo() + { + } + + //! Status MatchingStatus status; - //!Remote endpoint GUID + //! Remote endpoint GUID GUID_t remoteEndpointGuid; }; -} -} -} +} // namespace rtps +} // namespace fastrtps +} // namespace eprosima #endif /* _FASTDDS_RTPS_MATCHINGINFO_H_ */ diff --git a/include/fastdds/rtps/common/SequenceNumber.h b/include/fastdds/rtps/common/SequenceNumber.h index 90f737a1a56..92fe98e9815 100644 --- a/include/fastdds/rtps/common/SequenceNumber.h +++ b/include/fastdds/rtps/common/SequenceNumber.h @@ -32,7 +32,6 @@ namespace eprosima { namespace fastrtps { namespace rtps { - //!@brief Structure SequenceNumber_t, different for each change in the same writer. //!@ingroup COMMON_MODULE struct RTPS_DllAPI SequenceNumber_t @@ -42,7 +41,7 @@ struct RTPS_DllAPI SequenceNumber_t //! uint32_t low = 0; - //!Default constructor + //! Default constructor SequenceNumber_t() noexcept { high = 0; @@ -366,8 +365,7 @@ struct SequenceNumberDiff #endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC -//!Structure SequenceNumberSet_t, contains a group of sequencenumbers. -//!@ingroup COMMON_MODULE +//! Structure SequenceNumberSet_t, contains a group of sequencenumbers. using SequenceNumberSet_t = BitmapRange; #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC diff --git a/include/fastdds/rtps/common/Types.h b/include/fastdds/rtps/common/Types.h index c0ba598d14e..e1c18b225eb 100644 --- a/include/fastdds/rtps/common/Types.h +++ b/include/fastdds/rtps/common/Types.h @@ -19,14 +19,13 @@ #ifndef _FASTDDS_RTPS_COMMON_TYPES_H_ #define _FASTDDS_RTPS_COMMON_TYPES_H_ -#include -#include +#include #include -#include - -#include +#include +#include #include +#include namespace eprosima { namespace fastrtps { @@ -34,7 +33,6 @@ namespace rtps { /*! * @brief This enumeration represents endianness types. - * @ingroup COMMON_MODULE */ enum Endianness_t { @@ -44,38 +42,35 @@ enum Endianness_t LITTLEEND = 0x0 }; -//!Reliability enum used for internal purposes -//!@ingroup COMMON_MODULE +//! Reliability enum used for internal purposes typedef enum ReliabilityKind_t { RELIABLE, BEST_EFFORT -}ReliabilityKind_t; +} ReliabilityKind_t; -//!Durability kind -//!@ingroup COMMON_MODULE +//! Durability kind typedef enum DurabilityKind_t { VOLATILE, //!< Volatile Durability TRANSIENT_LOCAL, //!< Transient Local Durability TRANSIENT, //!< Transient Durability. PERSISTENT //!< NOT IMPLEMENTED. -}DurabilityKind_t; +} DurabilityKind_t; -//!Endpoint kind -//!@ingroup COMMON_MODULE +//! Endpoint kind typedef enum EndpointKind_t { READER, WRITER -}EndpointKind_t; +} EndpointKind_t; -//!Topic kind +//! Topic kind typedef enum TopicKind_t { NO_KEY, WITH_KEY -}TopicKind_t; +} TopicKind_t; #if FASTDDS_IS_BIG_ENDIAN_TARGET constexpr Endianness_t DEFAULT_ENDIAN = BIGEND; @@ -84,8 +79,6 @@ constexpr Endianness_t DEFAULT_ENDIAN = LITTLEEND; #endif // if FASTDDS_IS_BIG_ENDIAN_TARGET using octet = unsigned char; -//typedef unsigned int uint; -//typedef unsigned short ushort; using SubmessageFlag = unsigned char; using BuiltinEndpointSet_t = uint32_t; using Count_t = uint32_t;