TR-069 Device.IP.Interface.IPv4Address Getter API.

Description

TR-069 Device.IP.Interface.IPv4Address object Getter API

This is the getter group of API for the Device.IP.Interface.{i}.IPv4Address.{j} object.

The interface for all functions is identical and is described here.

Parameters

[in]	*name	This is the complete path name of the parameter extracted from soap message, e.g. ::get_Device_IP_Interface_IPv4Address_Enable. In this case, the path is "Device.IP.Interface.{i}.IPv4Address.{j}.Enable".
[in]	*type	Data type of parameter defined for TR-069. This is same as the data type used in the Xi3 data-model.xml file. (see parameter.h)
[out]	*value	This is the value of the parameter requested by the ACS. (see paramaccess.h)

Returns

The status of the operation.

Return values

OK	If parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERROR	If parameter requested was successfully fetched. (Same as OK).
DIAG_ERROR	Diagnostic error.
ERR_???	Appropriate error value otherwise (see dimark_globals.h).

Data Structures
class	hostIf_IPv4Address
	This class provides the hostIf IPv4 interface address for getting interface address information. More...

---

Data Structure Documentation

hostIf_IPv4Address

class hostIf_IPv4Address

This class provides the hostIf IPv4 interface address for getting interface address information.

Definition at line 127 of file Device_IP_Interface_IPv4Address.h.

Collaboration diagram for hostIf_IPv4Address:

Public Member Functions
int	handleGetMsg (const char *pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t *stMsgData)
int	handleSetMsg (const char *pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t *stMsgData)
int	get_IPv4Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	Get status (enabled/disabled) of IPv4 address. More...
int	get_IPv4Address_Status (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	This function gets the status of an IPv4 Address table entry. It provides the status of this IPv4Address table entry. Possible enum values are Disabled, Enabled, Error_Misconfigured and Error (OPTIONAL). More...
int	get_IPv4Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	This function gets the instance handle for an IPv4 Address of an IP Interface. It provides a non-volatile handle used to reference this IPv4 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_IPv4Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	This function used to get an IP Interface IPv4 IP Address. More...
int	get_IPv4Address_SubnetMask (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	This function gets an IP Interface IPv4 Address SubnetMask. More...
int	get_IPv4Address_AddressingType (HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged=NULL)
	This function gets an IP Interface IPv4 Address AddressingType assign the IP address. Possible enum values are DHCP, AutoIP, IPCP and Static. More...
int	set_IPv4Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets the device IP Interface IPv4 Address to 'Enable' or 'Disable'. More...
int	set_IPv4Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets a non-volatile handle used to reference this IPv4 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	set_IPv4Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets an IP Interface IPv4 Address. More...
int	set_IPv4Address_SubnetMask (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets an IP Interface IPv4Address Subnet Mask of an IPv4 address. More...
Static Public Member Functions
static hostIf_IPv4Address *	getInstance (int dev_id)
static GList *	getAllInstances ()
static void	closeInstance (hostIf_IPv4Address *)
static void	closeAllInstances ()
static void	getLock ()
static void	releaseLock ()
Private Member Functions
	hostIf_IPv4Address (int dev_id)
	Class Constructor of the class hostIf_IPv4Address. More...
void	refreshInterfaceName ()
int	getIPv4AddressAndMask (int instance, struct in_addr &in_address, struct in_addr &in_mask)
bool	hasPhysicalInterfaceAs (char *phy_if_name)
int	setIpOrMask (int interfaceNo, char *value, const char *ipOrMask)
Static Private Member Functions
static bool	isLinkLocalAddress (const struct in_addr &in_address)
	tests if an IPv4 address is link-local. More...
Private Attributes
int	dev_id
char	nameOfInterface [IF_NAMESIZE]
bool	bCalledEnable
bool	bCalledStatus
bool	bCalledIPAddress
bool	bCalledSubnetMask
bool	bCalledAddressingType
bool	backupEnable
char	backupStatus [BUFF_LENGTH_16]
char	backupIPAddress [BUFF_LENGTH_64]
char	backupSubnetMask [BUFF_LENGTH_64]
char	backupAddressingType [BUFF_LENGTH_16]
Static Private Attributes
static GHashTable *	ifHash = NULL
static GMutex *	m_mutex = NULL