RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.DeviceInfo.ProcessStatus.Process.Interface.{i}) Public APIs

Description

Describe the details about TR-069 DeviceInfo processor status process APIs specifications.

Functions

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_PID (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the Process Identifier. More...
 
int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Command (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides The name of the command that has caused the process to exist. More...
 
int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Size (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides The Size in Kilo bytes of the memory occupied by process. More...
 
int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Priority (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides The priority of the process. More...
 
int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_CPUTime (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides The amount of time spent by the process taking the cpu. More...
 
int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_State (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides The current state of the process. More...
 

Function Documentation

◆ get_Device_DeviceInfo_ProcessStatus_Process_PID()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_PID ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides the Process Identifier.

Description. This is the getter api for Device_DeviceInfo_ProcessStatus_Process. for Device_DeviceInfo_ProcessStatus_Process. object Profile.

Parameters
[in]nameComplete path name of the parameter.
[in]typeIt is a user data type of ParameterType.
[out]valueIt is the value of the parameter.
Return values
OKif successful.
XXX_ERR_BADPARAMif a bad parameter was supplied.
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.
See also
XXX_SomeOtherFunction.
Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 375 of file Device_DeviceInfo_ProcessStatus_Process.cpp.

◆ get_Device_DeviceInfo_ProcessStatus_Process_Command()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Command ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides The name of the command that has caused the process to exist.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 408 of file Device_DeviceInfo_ProcessStatus_Process.cpp.

◆ get_Device_DeviceInfo_ProcessStatus_Process_Size()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Size ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides The Size in Kilo bytes of the memory occupied by process.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 456 of file Device_DeviceInfo_ProcessStatus_Process.cpp.

◆ get_Device_DeviceInfo_ProcessStatus_Process_Priority()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_Priority ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides The priority of the process.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 489 of file Device_DeviceInfo_ProcessStatus_Process.cpp.

◆ get_Device_DeviceInfo_ProcessStatus_Process_CPUTime()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_CPUTime ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides The amount of time spent by the process taking the cpu.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 522 of file Device_DeviceInfo_ProcessStatus_Process.cpp.

◆ get_Device_DeviceInfo_ProcessStatus_Process_State()

int hostIf_DeviceProcess::get_Device_DeviceInfo_ProcessStatus_Process_State ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This function provides The current state of the process.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 555 of file Device_DeviceInfo_ProcessStatus_Process.cpp.