RDK Documentation (Open Sourced RDK Components)

Description

TR-069 Device.IP.ActivePort object Getter API

This is the getter group of API for the Device.IP.ActivePort.{i} object.

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

Parameters
[in]*nameThis is the complete path name of the parameter extracted from soap message, e.g. ::get_Device_IP_ActivePort_LocalIPAddress. In this case, the path is "Device.IP.ActivePort.{i}.LocalIPAddress".
[in]*typeData 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]*valueThis is the value of the parameter requested by the ACS. (see paramaccess.h)
Returns
The status of the operation.
Return values
OKIf parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERRORIf parameter requested was successfully fetched. (Same as OK).
DIAG_ERRORDiagnostic error.
ERR_???Appropriate error value otherwise (see dimark_globals.h).

Modules

 TR-069 Object (Device.IP.ActivePort.Interface.{i}) Public DataStructure
 Describe the details about data structure used in TR-069 Device IP active port.
 

Data Structures

class  hostIf_IPActivePort
 This class provides the hostIf IP active port for getting IP active port information. More...
 

Data Structure Documentation

◆ hostIf_IPActivePort

class hostIf_IPActivePort

This class provides the hostIf IP active port for getting IP active port information.

Definition at line 53 of file Device_IP_ActivePort.cpp.

Inheritance diagram for hostIf_IPActivePort:
Inheritance graph
Collaboration diagram for hostIf_IPActivePort:
Collaboration graph

Public Member Functions

int handleGetMsg (const char *pSetting, HOSTIF_MsgData_t *stMsgData)
 
int get_Device_IP_ActivePort_LocalIPAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function gets the local IP Address of the connection. More...
 
int get_Device_IP_ActivePort_LocalPort (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function gets the local port number of the connection. More...
 
int get_Device_IP_ActivePort_RemoteIPAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function gets the remote IP Address of the established connection. It provides the remote IP address of the source of inbound packets. More...
 
int get_Device_IP_ActivePort_RemotePort (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function gets the remote port number of the established connection. It provides the remote port number of the source of inbound packets. More...
 
int get_Device_IP_ActivePort_Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function gets the current operational status of the connection. The possible values are 'LISTEN', 'ESTABLISHED'. More...
 

Static Public Member Functions

static hostIf_IPActivePortgetInstance (int dev_id)
 
static void closeInstance (hostIf_IPActivePort *)
 
static GList * getAllInstances ()
 
static void closeAllInstances ()
 
static void getLock ()
 
static void releaseLock ()
 

Private Member Functions

 hostIf_IPActivePort (int dev_id)
 Class Constructor of the class hostIf_IPActivePort. More...
 
int getActivePortsFields (unsigned int activePortNo)
 

Private Attributes

int dev_id
 
bool bCalledLocalIPAddress
 
bool bCalledLocalPort
 
bool bCalledRemoteIPAddress
 
bool bCalledRemotePort
 
bool bCalledStatus
 
char backupLocalIPAddress [16]
 
char backupRemoteIPAddress [16]
 
char backupStatus [16]
 
unsigned int backupLocalPort
 
unsigned int backupRemotePort
 

Static Private Attributes

static GHashTable * ifHash = NULL
 
static GMutex * m_mutex = NULL
 
static struct Device_IP_ActivePort activePort