Description

TR-069 Device.IP.Interface object Getter API

This is the getter group of API for the Device.IP.Interface.{i} 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_Status. In this case, the path is "Device.IP.Interface.{i}.Status".
[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_IPInterface
	This class provides the hostIf IP interface for getting IP interface information. More...

Data Structure Documentation

◆ hostIf_IPInterface

class hostIf_IPInterface

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

Definition at line 224 of file Device_IP_Interface.h.

Collaboration diagram for hostIf_IPInterface:

Public Member Functions
int	handleGetMsg (const char pSetting, HOSTIF_MsgData_t stMsgData)

int	handleSetMsg (const char pSetting, HOSTIF_MsgData_t stMsgData)

void	getInterfaceOperationalState (char *operationalState)

unsigned int	getIPv4AddressNumberOfEntries ()

unsigned int	getIPv6AddressNumberOfEntries ()

unsigned int	getIPv6PrefixNumberOfEntries ()

int	get_Interface_Enable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status to enabled or disabled of an IP Interface. It provides the values such as 'true' or 'false' to Enable the status of IP interface. More...

int	get_Interface_IPv4Enable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status of the IPv4 stack attachment for an IP interface. It indicates whether or not this IP interface is attached to the IPv4 stack. If set to 'true', then this interface is attached to the IPv4 stack. If set to 'false', then this interface is detached from the IPv4 stack. More...

int	get_Interface_IPv6Enable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)

int	get_Interface_ULAEnable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status 'enabled' or 'disabled' of ULA(Unique local address) generation for an IP Interface. It indicates the status as 'true' or 'false' of the ULA generation and use this IP interface is enabled. Currently not implemented. More...

int	get_Interface_Status (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP interface Status. It provides the current operational state of the Interface. Possible state are Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown Error (OPTIONAL). More...

int	get_Interface_Alias (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the instance handle for an IP Interface. It provides a non-volatile handle used to reference this IP interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...

int	get_Interface_Name (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface Name.It provides the textual name of the interface as assigned by the CPE(Customer Premises Equipment). More...

int	get_Interface_LastChange (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the last change of status time of the interface. It provides the accumulated time in seconds since the interface entered its current operational state. Currently not implemented. More...

int	get_Interface_LowerLayers (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get IP Interface LowerLayers. More...

int	get_Interface_Router (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the Router instance that is associated with an IP Interface entry. It provides the Router instance that is associated with this IP Interface entry. Currently not implemented. More...

int	get_Interface_Reset (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get IP Interface Reset status. More...

int	get_Interface_MaxMTUSize (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface MaxMTUSize. It provides the maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. More...

int	get_Interface_Type (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface Type. It provides the IP interface type. Possible values are Normal, Loopback, Tunnel, Tunnelled. More...

int	get_Interface_Loopback (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP interface loopback. It indicates whether or not the IP interface is a loopback interface by 'true' or 'false'. More...

int	get_Interface_IPv4AddressNumberOfEntries (HOSTIF_MsgData_t *stMsgData)
	Get the IP Interface IPv4AddressNumberOfEntries. More...

int	get_Interface_AutoIPEnable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get the status (enabled/disabled) of Auto-IP on an IP Interface. More...

int	set_Interface_Enable (HOSTIF_MsgData_t *stMsgData)
	Set the status (enabled/disabled) of IP Interface. More...

int	set_Interface_IPv4Enable (HOSTIF_MsgData_t *stMsgData)
	Attach/Detach an IP interface to/from the IPv4 stack. More...

int	set_Interface_ULAEnable (HOSTIF_MsgData_t *stMsgData)
	This function sets the status 'enabled' or 'disabled' of ULA(Unique Local Address) generation for an IP Interface. It controls whether or not ULAs are generated and used on this interface. Currently not implemented. More...

int	set_Interface_Alias (HOSTIF_MsgData_t *stMsgData)
	This function sets a non-volatile handle used to reference this IP interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...

int	set_Interface_LowerLayers (HOSTIF_MsgData_t *stMsgData)
	This function sets the IP Interface LowerLayers. Given a comma-separated list (maximum length 1024) of strings, each list item being the path name of an interface object, this function MUST stack each item in the list immediately below this interface object. Currently not implemented. More...

int	set_Interface_Router (HOSTIF_MsgData_t *stMsgData)
	This function sets the router instance that is associated with an IP Interface entry. Currently not implemented. More...

int	set_Interface_Reset (HOSTIF_MsgData_t *stMsgData)
	This function sets the Reset flag to the requested value (normally 'true'). Currently not implemented. More...

int	set_Interface_MaxMTUSize (HOSTIF_MsgData_t *stMsgData)
	This function sets the size of maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. Currently not implemented. More...

int	set_Interface_Loopback (HOSTIF_MsgData_t *stMsgData)
	This function sets the IP interface LoopBack flag to 'true' or 'false'. Currently not implemented. More...

int	set_Interface_AutoIPEnable (HOSTIF_MsgData_t *stMsgData)
	This function sets the Auto-IP on an IP Interface status 'enable' or 'disable'. It sets 'true' for enable and 'false' for disables the auto-IP for this IP interface. Currently not implemented. More...

Static Public Member Functions
static hostIf_IPInterface *	getInstance (int dev_id)

static void	closeInstance (hostIf_IPInterface *)

static GList *	getAllInstances ()

static void	closeAllInstances ()

static void	getActiveFlags (char *nameOfInterface, struct ifreq &ifr)

static bool	isLoopback (char *nameOfInterface)

static bool	isEnabled (char *nameOfInterface)

static int	getMTU (char *nameOfInterface)

Private Member Functions
	hostIf_IPInterface (int dev_id)
	Class Constructor of the class hostIf_IPInterface. More...

void	refreshInterfaceName ()

unsigned int	getIPAddressNumberOfEntries (sa_family_t address_family)

int	set_Interface_Reset (unsigned int value)

int	set_Interface_Enable (int value)

int	set_Interface_Mtu (unsigned int value)

Private Attributes
int	dev_id

char	nameOfInterface [IF_NAMESIZE]

bool	bCalledEnable

bool	bCalledIPv4Enable

bool	bCalledIPv6Enable

bool	bCalledStatus

bool	bCalledName

bool	bCalledReset

bool	bCalledMaxMTUSize

bool	bCalledType

bool	bCalledLoopback

bool	bCalledIPv4AddressNumberOfEntries

unsigned int	backupIPv4AddressNumberOfEntries

unsigned int	backupMaxMTUSize

bool	backupLoopback

bool	backupReset

bool	backupIPv4Enable

bool	backupIPv6Enable

bool	backupEnable

char	backupType [_BUF_LEN_16]

char	backupName [_BUF_LEN_16]

char	backupStatus [_BUF_LEN_16]

Static Private Attributes
static GHashTable *	ifHash = NULL

static IPInterface	stIPInterfaceInstance

Description

TR-069 Device.IP.Interface object Getter API

Data Structures

Data Structure Documentation

◆ hostIf_IPInterface

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes