modularization/thirdpartylib/FastRTPS/include/fastdds/rtps/attributes/EndpointAttributes.h

// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @file fastdds/rtps/attributes/EndpointAttributes.h
 */

#ifndef _FASTDDS_ENDPOINTATTRIBUTES_H_
#define _FASTDDS_ENDPOINTATTRIBUTES_H_

#include <fastdds/rtps/common/Types.h>
#include <fastdds/rtps/common/Locator.h>
#include <fastdds/rtps/attributes/PropertyPolicy.h>
#include <fastdds/rtps/security/accesscontrol/EndpointSecurityAttributes.h>

namespace eprosima {
namespace fastrtps{
namespace rtps {

/**
 * Structure EndpointAttributes, describing the attributes associated with an RTPS Endpoint.
 * @ingroup RTPS_ATTRIBUTES_MODULE
 */
class EndpointAttributes
{
    public:
        //!Endpoint kind, default value WRITER
        EndpointKind_t endpointKind;

        //!Topic kind, default value NO_KEY
        TopicKind_t topicKind;

        //!Reliability kind, default value BEST_EFFORT
        ReliabilityKind_t reliabilityKind;

        //!Durability kind, default value VOLATILE
        DurabilityKind_t durabilityKind;

        //!GUID used for persistence
        GUID_t persistence_guid;

        //!Unicast locator list
        LocatorList_t unicastLocatorList;

        //!Multicast locator list
        LocatorList_t multicastLocatorList;

        //! Remote locator list.
        LocatorList_t remoteLocatorList;

        //!Properties
        PropertyPolicy properties;

        EndpointAttributes()
            : endpointKind(WRITER)
            , topicKind(NO_KEY)
            , reliabilityKind(BEST_EFFORT)
            , durabilityKind(VOLATILE)
            , persistence_guid()
            , m_userDefinedID(-1)
            , m_entityID(-1)
        {
        }

        virtual ~EndpointAttributes(){};

        /**
         * Get the user defined ID
         * @return User defined ID
         */
        inline int16_t getUserDefinedID() const { return m_userDefinedID; }

        /**
         * Get the entity defined ID
         * @return Entity ID
         */
        inline int16_t getEntityID() const { return m_entityID; }

        /**
         * Set the user defined ID
         * @param id User defined ID to be set
         */
        inline void setUserDefinedID(uint8_t id) { m_userDefinedID = id; }

        /**
         * Set the entity ID
         * @param id Entity ID to be set
         */
        inline void setEntityID(uint8_t id) { m_entityID = id; }

    #if HAVE_SECURITY
        const security::EndpointSecurityAttributes& security_attributes() const { return security_attributes_; }

        security::EndpointSecurityAttributes& security_attributes() { return security_attributes_; }
    #endif

    private:
        //!User Defined ID, used for StaticEndpointDiscovery, default value -1.
        int16_t m_userDefinedID;

        //!Entity ID, if the user want to specify the EntityID of the enpoint, default value -1.
        int16_t m_entityID;

    #if HAVE_SECURITY
        security::EndpointSecurityAttributes security_attributes_;
    #endif
};

} /* namespace rtps */
} /* namespace fastrtps */
} /* namespace eprosima */

#endif /* _FASTDDS_ENDPOINTATTRIBUTES_H_ */