LocalNetworkDescription.h

// LocalNetworkDescription.h:
// --------------------------
//

#ifndef __IPSDKCORE_LOCALNETWORKDESCRIPTION_H__
#define __IPSDKCORE_LOCALNETWORKDESCRIPTION_H__

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

#include <IPSDKCore/IPSDKCoreExports.h>
#include <IPSDKCore/Config/Network/NetworkDescriptionTypes.h>
#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <IPSDKUtil/Dynamic/BaseDynamicObject.h>

namespace ipsdk {
namespace core {

class NetworkDescription;
class LocalComputerInfo;


class IPSDKCORE_API LocalNetworkDescription : public BaseDynamicObject
{
    // declare a dynamic object
    IPSDK_DECLARE_DYNAMIC_WITH_COPY(IPSDKCore, LocalNetworkDescription)

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

    BoolResult                      init(const NetworkDescription& networkDescription,
                                         const LocalComputerInfo& localComputerInfo);

    ipUInt32                        getPortNumber() const;

    const tcpip::eIPAddressType&    getIPAddressType() const;

    const tcpip::Address&           getLocalIPAddress() const;

    const tcpip::Address&           getMasterIPAddress() const;

    const AddressColl&              getRemoteAddressColl() const;

    const AddressColl&              getSlavesAddressColl() const;

    void                            clear();

// attributes
protected:
    ipUInt32                _portNumber;

    tcpip::eIPAddressType   _ipAddressType;

    tcpip::Address          _localIPAddress;

    tcpip::Address          _masterIPAddress;

    AddressColl             _remoteAddressColl;

    AddressColl             _slavesAddressColl;

    bool                    _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKCORE_LOCALNETWORKDESCRIPTION_H__