TR-069 Device.Ethernet Getter API.

Description

TR-069 Device.Ethernet object Getter API

This is the getter group of API for the Device.Ethernet 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_Ethernet_InterfaceNumberOfEntries. In this case, the path is "Device.Ethernet.InterfaceNumberOfEntries".
[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_EthernetInterface
	This class provides the interface for getting Device ethernet interface information. More...

---

Data Structure Documentation

hostIf_EthernetInterface

class hostIf_EthernetInterface

This class provides the interface for getting Device ethernet interface information.

Definition at line 195 of file Device_Ethernet_Interface.h.

Collaboration diagram for hostIf_EthernetInterface:

Public Member Functions
int	get_Device_Ethernet_Interface_Enable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the status (enabled/disabled) of an Ethernet interface. More...
int	get_Device_Ethernet_Interface_Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the status of an Ethernet Interface. More...
int	get_Device_Ethernet_Interface_Alias (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the instance handle for an Ethernet Interface. More...
int	get_Device_Ethernet_Interface_Name (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the textual name of the 'Ethernet' interface. More...
int	get_Device_Ethernet_Interface_LastChange (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the time since an Ethernet interface's last change of status. More...
int	get_Device_Ethernet_Interface_LowerLayers (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function provides a comma-separated list (maximum length 1024) of strings. Each list item MUST be the path name of an interface object that is stacked immediately below this Ethernet interface object. Currently not implemented. More...
int	get_Device_Ethernet_Interface_Upstream (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function indicates whether the interface points towards the Internet represent by 'true' or towards End Devices represent by false For example: More...
int	get_Device_Ethernet_Interface_MACAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function provides the MAC Address of this Ethernet interface. More...
int	get_Device_Ethernet_Interface_MaxBitRate (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function provides the maximum upstream and downstream PHY bit rate supported by this Ethernet interface it expressed in Mbps. More...
int	get_Device_Ethernet_Interface_DuplexMode (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the Duplex Mode available on an Ethernet Interface. More...
int	set_Device_Ethernet_Interface_Enable (HOSTIF_MsgData_t *)
	This function sets the status of 'Ethernet' interface as enabled or disabled. More...
int	set_Device_Ethernet_Interface_Alias (HOSTIF_MsgData_t *)
	This function sets a non-volatile handle used to reference this Ethernet interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. This function is currently not implemented. More...
int	set_Device_Ethernet_Interface_LowerLayers (HOSTIF_MsgData_t *)
	This function sets the 'Ethernet' interface 'LowerLayers'. Given a comma-separated list (maximum length 1024) of strings, each list item being the path name of an 'Ethernet' interface object, this function MUST stack each item in the list immediately below this interface object. Currently not implemented. More...
int	set_Device_Ethernet_Interface_MaxBitRate (HOSTIF_MsgData_t *)
	Set the maximum bit rate attainable on an Ethernet Interface. More...
int	set_Device_Ethernet_Interface_DuplexMode (HOSTIF_MsgData_t *)
	This function sets the 'Duplex Mode' available on an ethernet Interface. This function sets the string indicating the duplex mode available to this Ethernet connection. This is an enumeration having values Half, Full, Auto. This function is currently not implemented. More...
Static Public Member Functions
static hostIf_EthernetInterface *	getInstance (int dev_id)
static void	closeInstance (hostIf_EthernetInterface *)
static GList *	getAllInstances ()
static void	closeAllInstances ()
static void	getLock ()
static void	releaseLock ()
static GHashTable *	getNotifyHash ()
static int	get_Device_Ethernet_InterfaceNumberOfEntries (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the number of entries in the Interface table. More...
Static Public Attributes
static EthernetInterface	stEthInterface = {0,}
Private Member Functions
	hostIf_EthernetInterface (int dev_id)
	Class Constructor of the class hostIf_EthernetInterface. More...
Private Attributes
int	dev_id
bool	backupEnable
bool	backupUpstream
int	backupMaxBitRate
char	backupStatus [_BUF_LEN_16]
char	backupName [_BUF_LEN_16]
char	backupMACAddress [24]
char	backupDuplexMode [_BUF_LEN_16]
bool	bCalledEnable
bool	bCalledStatus
bool	bCalledName
bool	bCalledUpstream
bool	bCalledMACAddress
bool	bCalledMaxBitRate
bool	bCalledDuplexMode
Static Private Attributes
static GHashTable *	ifHash = NULL
static GHashTable *	m_notifyHash = NULL
static GMutex *	m_mutex = NULL