NetworkDescription.h

// NetworkDescription.h:
// ---------------------
//

#ifndef __IPSDKCORE_NETWORKDESCRIPTION_H__
#define __IPSDKCORE_NETWORKDESCRIPTION_H__

// suppression warnings
// warning C4251: 'ipsdk::core::NetworkDescription::_ipAddressType' : class 'ipsdk::tcpip::eIPAddressType' needs to have dll-interface to be used by clients of class 'ipsdk::core::NetworkDescription'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKCore/IPSDKCoreExports.h>
#include <IPSDKCore/Config/Network/NetworkDescriptionTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace core {


class IPSDKCORE_API NetworkDescription : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKCore, NetworkDescription)

public:
    NetworkDescription();
    ~NetworkDescription();
    
// methods
public:
    bool                            isInit() const;

    void                            init(ipUInt32 portNumber,
                                         const tcpip::eIPAddressType& iPAddressType);

    ipUInt32                        getPortNumber() const;

    const tcpip::eIPAddressType&    getIPAddressType() const;

    bool                            isValidAddress(const tcpip::Address& address) const;

    bool                            existsAddress(const tcpip::Address& address) const;

    bool                            isMasterAddress(const tcpip::Address& address) const;

    bool                            isSlaveAddress(const tcpip::Address& address) const;

    void                            addMasterAddress(const tcpip::Address& masterAddress);

    void                            addSlaveAddress(const tcpip::Address& masterAddress,
                                                    const AddressColl& slavesColl);

    void                            addSlaveAddress(const tcpip::Address& masterAddress,
                                                    const tcpip::Address& slaveAddress);

    const AddressHierarchy&         getAddressHierarchy() const;

    const AddressColl&              getSlavesColl(const tcpip::Address& masterAddress) const;

    const tcpip::Address&           getMasterAddress(const tcpip::Address& slaveAddress) const;

    const AddressColl&              getGlobalAddressColl() const;

    void                            clear();

// attributes
protected:
    ipUInt32                _portNumber;

    tcpip::eIPAddressType   _ipAddressType;

    AddressHierarchy        _addressHierarchy;

    AddressColl             _globalAddressColl;

    bool                    _bInit;
};


inline bool
NetworkDescription::isInit() const
{
    return _bInit;
}


} // end of namespace core
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKCORE_NETWORKDESCRIPTION_H__