Spinnaker C++
2.6.0.0
Classes | Enumerations | Functions
AdapterConfig Namespace Reference

Classes

struct  IpInfo
 
struct  AdapterInfo
 

Enumerations

enum  AdapterConfigErr {
  IP_ADDRESS_INVALID, IP_ADDRESS_IS_NOT_V4, IP_ADDRESS_TOO_LARGE, IP_ADDRESS_TOO_SMALL,
  HOST_ADDRESS_ZERO, SUBNET_MASK_INVALID, VALID_SUBNET_NOT_FOUND
}
 

Functions

ADAPTERCONFIG_API std::vector
< AdapterInfo
RetrieveAllAdapters ()
 
ADAPTERCONFIG_API void AutoPopulateAdapterInfo (std::vector< AdapterInfo > &adaptersToConfigure, const std::vector< AdapterInfo > &allAdapters)
 
ADAPTERCONFIG_API void AutoPopulateAdvancedProperties (std::vector< AdapterInfo > &adaptersToConfigure)
 
ADAPTERCONFIG_API void PopulateAdapterIpInfo (IpInfo startingIpInfo, std::vector< AdapterInfo > &adaptersToConfigure, const std::vector< AdapterInfo > &allAdapters, bool skipIfIPValid=false)
 
ADAPTERCONFIG_API void ValidateIpAddress (const std::string &ipAddr, unsigned int subnetMaskLength)
 
ADAPTERCONFIG_API bool IsValidIpAddress (const std::string &ipAddr)
 
ADAPTERCONFIG_API bool IsValidSubnetMask (const std::string &subnetMask)
 
ADAPTERCONFIG_API bool IsOnSameSubnet (const std::string &ipAddrStr1, const std::string &ipAddrStr2, const unsigned int subnetMaskLength)
 
ADAPTERCONFIG_API unsigned int GetSubnetMaskLength (const std::string &subnetMask)
 
ADAPTERCONFIG_API std::string GetEnumerationLogFileName ()
 
ADAPTERCONFIG_API std::string GetConfigLogFileName ()
 
ADAPTERCONFIG_API void ConfigureAdapter (AdapterInfo &adapter, bool configureIP, bool configureAdvancedProperties)
 
ADAPTERCONFIG_API unsigned int GetAutoSubnetMaskLength ()
 
ADAPTERCONFIG_API std::string GetAutoSubnetMask ()
 
ADAPTERCONFIG_API std::string GetMaxIpAddress ()
 
ADAPTERCONFIG_API std::string GetMinIpAddress ()
 
ADAPTERCONFIG_API std::string GetAutoGigabitDesc ()
 
ADAPTERCONFIG_API std::string GetAuto10GDesc ()
 
ADAPTERCONFIG_API std::string GetAutoStartIp ()
 

Enumeration Type Documentation

Enumerator
IP_ADDRESS_INVALID 
IP_ADDRESS_IS_NOT_V4 
IP_ADDRESS_TOO_LARGE 
IP_ADDRESS_TOO_SMALL 
HOST_ADDRESS_ZERO 
SUBNET_MASK_INVALID 
VALID_SUBNET_NOT_FOUND 

Function Documentation

ADAPTERCONFIG_API void AdapterConfig::AutoPopulateAdapterInfo ( std::vector< AdapterInfo > &  adaptersToConfigure,
const std::vector< AdapterInfo > &  allAdapters 
)
ADAPTERCONFIG_API void AdapterConfig::AutoPopulateAdvancedProperties ( std::vector< AdapterInfo > &  adaptersToConfigure)
ADAPTERCONFIG_API void AdapterConfig::ConfigureAdapter ( AdapterInfo &  adapter,
bool  configureIP,
bool  configureAdvancedProperties 
)
ADAPTERCONFIG_API std::string AdapterConfig::GetAuto10GDesc ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetAutoGigabitDesc ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetAutoStartIp ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetAutoSubnetMask ( )
ADAPTERCONFIG_API unsigned int AdapterConfig::GetAutoSubnetMaskLength ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetConfigLogFileName ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetEnumerationLogFileName ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetMaxIpAddress ( )
ADAPTERCONFIG_API std::string AdapterConfig::GetMinIpAddress ( )
ADAPTERCONFIG_API unsigned int AdapterConfig::GetSubnetMaskLength ( const std::string &  subnetMask)
ADAPTERCONFIG_API bool AdapterConfig::IsOnSameSubnet ( const std::string &  ipAddrStr1,
const std::string &  ipAddrStr2,
const unsigned int  subnetMaskLength 
)
ADAPTERCONFIG_API bool AdapterConfig::IsValidIpAddress ( const std::string &  ipAddr)
ADAPTERCONFIG_API bool AdapterConfig::IsValidSubnetMask ( const std::string &  subnetMask)
ADAPTERCONFIG_API void AdapterConfig::PopulateAdapterIpInfo ( IpInfo  startingIpInfo,
std::vector< AdapterInfo > &  adaptersToConfigure,
const std::vector< AdapterInfo > &  allAdapters,
bool  skipIfIPValid = false 
)
ADAPTERCONFIG_API std::vector<AdapterInfo> AdapterConfig::RetrieveAllAdapters ( )
ADAPTERCONFIG_API void AdapterConfig::ValidateIpAddress ( const std::string &  ipAddr,
unsigned int  subnetMaskLength 
)
Contact Support Spinnaker® SDK Programmer's Guide and API Reference