RDK Documentation (Open Sourced RDK Components)

Description

Describe the details about classes used in TR069 Device IPv6 Interface address.

Data Structures

class  hostIf_IPv6Address
 This class provides the hostIf IP interface for getting IPv6 interface information. More...
 

Data Structure Documentation

◆ hostIf_IPv6Address

class hostIf_IPv6Address

This class provides the hostIf IP interface for getting IPv6 interface information.

Definition at line 81 of file Device_IP_Interface_IPv6Address.h.

Collaboration diagram for hostIf_IPv6Address:
Collaboration graph

Public Member Functions

int handleGetMsg (const char *pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t *stMsgData, bool isAddress)
 
int handleSetMsg (const char *pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t *stMsgData, bool isAddress)
 
int get_IPv6Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 This function provides the value 'true' or 'false' for Enable status of IPv6 address. More...
 
int get_IPv6Address_Status (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 This function provides the status of this IPv6Address table entry. Possible values. More...
 
int get_IPv6Address_IPAddressStatus (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 This function provides a non-volatile handle used to reference this IPv6 address instance of this IP interface. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...
 
int get_IPv6Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 This function provides the IPv6 address. More...
 
int get_IPv6Address_Origin (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 This function provides the addressing method used to assign the IP address. The Possible enum vlaues. More...
 
int get_IPv6Address_Prefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Address_PreferredLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Address_ValidLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Address_Anycast (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Status (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_PrefixStatus (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Prefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Origin (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_StaticType (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_ParentPrefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_ChildPrefixBits (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_OnLink (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_Autonomous (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_PreferredLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int get_IPv6Prefix_ValidLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
 
int set_IPv6Address_Prefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Address_PreferredLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Address_ValidLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Address_Anycast (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_Prefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_StaticType (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_ParentPrefix (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_ChildPrefixBits (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_OnLink (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_Autonomous (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_PreferredLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Prefix_ValidLifetime (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 
int set_IPv6Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 Enable/Disable an IP Interface IPv6 Address. More...
 
int set_IPv6Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 Set the instance handle for an IPv6 Address of an IP Interface. More...
 
int set_IPv6Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
 Set an IP Interface IPv6 Address. More...
 

Static Public Member Functions

static hostIf_IPv6AddressgetInstance (int dev_id)
 
static GList * getAllInstances ()
 
static void closeInstance (hostIf_IPv6Address *)
 
static void closeAllInstances ()
 

Private Member Functions

 hostIf_IPv6Address (int dev_id)
 
int getIPv6AddressAndMask (int instance, struct in6_addr &in6_address, struct in6_addr &in6_mask)
 
int getIPv6Prefix (int instance, struct in6_addr &in6_prefix_address, unsigned int &prefix_length)
 
bool get_ipv6address_lifetime (unsigned int instance, char *search_string, long int &lifetime)
 
bool get_ipv6address_preferred_lifetime (unsigned int instance, long int &preferred_lifetime)
 
bool get_ipv6address_valid_lifetime (unsigned int instance, long int &valid_lifetime)
 
void convert_lifetime_to_string (long int t, char *lifetime)
 
int setIp (int interfaceNo, char *value)
 
int removeIp (int interfaceNo, char *value)
 
void refreshInterfaceName ()
 
int get_IPv6Prefix_Origin (int instance, char *origin)
 
int get_IPv6Prefix_StaticType (int instance, char *staticType)
 
int get_IPv6Prefix_ParentPrefix (int instance, char *parentPrefix)
 
int get_IPv6Prefix_ChildPrefixBits (int instance, char *childPrefixBits)
 

Static Private Member Functions

static bool isLinkLocalAddress (const struct in6_addr &in6_address)
 tests if an IPv6 address is link-local. More...
 

Private Attributes

int dev_id
 
char nameOfInterface [IF_NAMESIZE]
 
bool bCalledEnable
 
bool bCalledStatus
 
bool bCalledIPAddress
 
bool bCalledOrigin
 
bool backupIPv6AddressEnable
 
char backupIPv6AddressStatus [BUFF_LENGTH_16]
 
char backupIPv6AddressIPAddress [BUFF_LENGTH_64]
 
char backupIPv6AddressOrigin [BUFF_LENGTH_32]
 
bool backupIPv6PrefixEnable
 
char backupIPv6PrefixStatus [BUFF_LENGTH_16]
 
char backupIPv6PrefixPrefix [BUFF_LENGTH_64]
 
char backupIPv6PrefixOrigin [BUFF_LENGTH_32]
 

Static Private Attributes

static GHashTable * ifHash = NULL
 
static GMutex * m_mutex = NULL
 
static const char * PREFERRED = "Preferred"
 
static const char * DEPRECATED = "Deprecated"
 
static const char * INVALID = "Invalid"
 
static const char * INACCESSIBLE = "Inaccessible"
 
static const char * UNKNOWN = "Unknown"
 
static const char * TENTATIVE = "Tentative"
 
static const char * DUPLICATE = "Duplicate"
 
static const char * OPTIMISTIC = "Optimistic"
 
static const char * AUTOCONFIGURED = "AutoConfigured"
 
static const char * DHCPv6 = "DHCPv6"
 
static const char * WELLKNOWN = "WellKnown"
 
static const char * STATIC = "Static"
 
static const char * PREFIXDELEGATION = "PrefixDelegation"
 
static const char * ROUTERADVERTISEMENT = "RouterAdvertisement"
 
static const char * CHILD = "Child"
 
static const char * INAPPLICABLE = "Inapplicable"
 

Member Function Documentation

◆ isLinkLocalAddress()

bool hostIf_IPv6Address::isLinkLocalAddress ( const struct in6_addr &  in6_address)
staticprivate

tests if an IPv6 address is link-local.

Parameters
[in]in6_addressthe IPv6 address to test.
Return values
trueif the IPv6 address is link-local.
falseotherwise.

Definition at line 485 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_ipv6address_lifetime()

bool hostIf_IPv6Address::get_ipv6address_lifetime ( unsigned int  instance,
char *  search_string,
long int &  lifetime 
)
private

returns: false if there was an error while trying to determine the specified lifetime true otherwise

below are possible values for the output parameter 'lifetime': -1 if lifetime cannot be determined -2 if lifetime is forever a non-negative value otherwise

Definition at line 1105 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_ipv6address_preferred_lifetime()

bool hostIf_IPv6Address::get_ipv6address_preferred_lifetime ( unsigned int  instance,
long int &  preferred_lifetime 
)
private

returns: false if there was an error while trying to determine the preferred lifetime true otherwise

below are possible values for the output parameter 'preferred_lifetime': -1 if preferred lifetime cannot be determined -2 if preferred lifetime is forever a non-negative value otherwise

Definition at line 1176 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_ipv6address_valid_lifetime()

bool hostIf_IPv6Address::get_ipv6address_valid_lifetime ( unsigned int  instance,
long int &  valid_lifetime 
)
private

returns: false if there was an error while trying to determine the valid lifetime true otherwise

below are possible values for the output parameter 'valid_lifetime': -1 if valid lifetime cannot be determined -2 if valid lifetime is forever a non-negative value otherwise

Definition at line 1191 of file Device_IP_Interface_IPv6Address.cpp.