TR-069 Device.IP Getter API.

Description

TR-069 Device.IP object Getter API

This is the getter group of API for the Device.IP 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_IPv4Capable. In this case, the path is "Device.IP.IPv4Capable".
[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_IP
	This class provides the hostIf IP interface for getting IP interface information. More...

---

Data Structure Documentation

hostIf_IP

class hostIf_IP

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

Definition at line 162 of file Device_IP.h.

Collaboration diagram for hostIf_IP:

Public Member Functions
int	handleGetMsg (HOSTIF_MsgData_t *stMsgData)
int	handleSetMsg (HOSTIF_MsgData_t *stMsgData)
int	get_Device_IP_IPv4Capable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the IPv4 capability of a device. More...
int	get_Device_IP_IPv4Enable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the status (enabled/disabled) of the IPv4 stack on a device. More...
int	get_Device_IP_IPv4Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the status of the IPv4 stack on a device. It indicates the status of the IPv4 stack. It is an enumeration of: Disabled, Enabled, Error (OPTIONAL). More...
int	get_Device_IP_ULAPrefix (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the ULA(Unique Local Address)/48 prefix for a device. This function provides the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented. More...
int	set_Device_IP_IPv4Enable (HOSTIF_MsgData_t *)
	Set the status (enabled/disabled) of the IPv4 stack on a device. More...
int	set_Device_IP_ULAPrefix (HOSTIF_MsgData_t *)
	This function sets the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented. More...
Static Public Member Functions
static hostIf_IP *	getInstance (int dev_id)
static void	closeInstance (hostIf_IP *)
static GList *	getAllInstances ()
static void	closeAllInstances ()
static void	getLock ()
static void	releaseLock ()
static char *	getInterfaceName (int if_index, char *if_name)
static unsigned int	getNumOfActivePorts (void)
static int	get_Device_IP_Fields (EIPMembers ipMem)
static GHashTable *	getNotifyHash ()
static int	get_Device_IP_InterfaceNumberOfEntries (HOSTIF_MsgData_t *)
	Get the number of entries in the Interface table. More...
static int	get_Device_IP_ActivePortNumberOfEntries (HOSTIF_MsgData_t *)
	Get the number of entries in the ActivePort table. More...
Private Member Functions
	hostIf_IP (int dev_id)
	Class Constructor of the class hostIf_IP. More...
Static Private Member Functions
static unsigned int	getInterfaceNumberOfEntries (void)
static unsigned int	getPhysicalInterfaceNumberOfEntries (struct if_nameindex *phy_if_list)
static unsigned int	getVirtualInterfaceNumberOfEntries (struct if_nameindex *phy_if_list)
static char *	getVirtualInterfaceName (struct if_nameindex *phy_if_list, unsigned int virtual_if_index, char *virtual_if_name)
Private Attributes
int	dev_id
bool	bCalledIPv4Capable
bool	bCalledIPv4Enable
bool	bCalledIPv4Status
bool	bCalledInterfaceNumberOfEntries
bool	bCalledActivePortNumberOfEntries
bool	backupIPv4Capable
bool	backupIPv4Enable
int	backupInterfaceNumberOfEntries
int	backupActivePortNumberOfEntries
char	backupIPv4Status [_BUF_LEN_16]
Static Private Attributes
static GHashTable *	ifHash = NULL
static GMutex *	m_mutex = NULL
static IP	stIPInstance = {TRUE,FALSE,{"Disabled"},FALSE,0,0}
static char *	cmd_NumOfActivePorts = "cat /proc/net/tcp | awk '$4 == \"0A\" || $4 == \"01\" {print $2" "$3" "$4}' | wc -l"
static GHashTable *	m_notifyHash = NULL