Device_DeviceInfo_ProcessStatus.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's Licenses.txt file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
 
/**
 * @file Device_DeviceInfo_ProcessStatus.h
 * @brief The header file provides TR069 device processor status information APIs.
 */
 
/**
 * @defgroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS TR-069 Object (Device.DeviceInfo.ProcessStatus)
 *  Status of the processes on the device.
 * @ingroup TR69_HOSTIF_DEVICEINFO
 *
 * @defgroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS_API TR-069 Object (Device.DeviceInfo.ProcessStatus.Interface.{i}) Public APIs
 * Describe the details about TR-069 DeviceInfo processor status APIs specifications.
 * @ingroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS
 *
 * @defgroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS_CLASSES TR-069 Object (Device.DeviceInfo.ProcessStatus.Interface.{i}) Public Classes
 * Describe the details about classes used in TR-069 DeviceInfo processor status.
 * @ingroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS
 */
 
/**
* @defgroup tr69hostif
* @{
* @defgroup hostif
* @{
**/
 
#ifndef DEVICE_DEVICEINFO_PROCESSSTATUS_H_
#define DEVICE_DEVICEINFO_PROCESSSTATUS_H_
 
/*****************************************************************************
 * TR069-SPECIFIC INCLUDE FILES
 *****************************************************************************/
#include "hostIf_main.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
#include "hostIf_tr69ReqHandler.h"
#include "hostIf_utils.h"
#include "hostIf_updateHandler.h"
 
#define PARAM_LEN 256
 
/**
 * @brief This class provides the interface for getting device processor status information.
 * @ingroup TR69_HOSTIF_DEVICE_PROCESSORSTATUS_CLASSES
 */
class hostIf_DeviceProcessStatusInterface
{
    hostIf_DeviceProcessStatusInterface(int dev_id);
    ~hostIf_DeviceProcessStatusInterface() {};
    static GHashTable *ifHash;
    static GMutex *m_mutex;
 
    int dev_id;
 
    bool bCalledCPUUsage;
    bool bCalledProcessNumberOfEntries;
 
    int backupCPUUsage;
    int backupProcessNumberOfEntries;
 
    unsigned int getNumOfProcessEntries();
    int getProcessStatusCPUUsage();
 
public:
 
    static hostIf_DeviceProcessStatusInterface *getInstance(int dev_id);
 
    static void closeInstance(hostIf_DeviceProcessStatusInterface *);
 
    static GList *getAllInstances();
 
    static void closeAllInstances();
 
    static void getLock();
 
    static void releaseLock();
 
    /**
     * Description. This is the getter api for Device_DeviceInfo_ProcessStatus. for
     *  Device_DeviceInfo_ProcessStatus. object Profile.
     *
     * @param[in]  name  Complete path name of the parameter.
     * @param[in]  type  It is a user data type of ParameterType.
     * @param[out] value It is the value of the parameter.
     *
     * @retval OK if successful.
     * @retval XXX_ERR_BADPARAM if a bad parameter was supplied.
     *
     * @execution Synchronous.
     * @sideeffect 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 XXX_SomeOtherFunction.
     */
 
 
 
    int get_Device_DeviceInfo_ProcessStatus_CPUUsage(HOSTIF_MsgData_t *stMsgData,bool *pChanged = NULL);
    /**
     * @brief get_Device_DeviceInfo_ProcessStatus_ProcessNumberOfEntries.
     *
     * This function provides The number of entries in the process table.
     *
     * @return The number of entries in the process table.
     *
     * @retval OK if is successful.
     * @retval ERR_INTERNAL_ERROR if not able to fetch.
     *
     * @sideeffect All necessary structures and buffers are deallocated.
     * @execution Synchronous.
     *
     */
 
};
/* End of doxygen group */
/**
 * @}
 */
 
#endif /* DEVICE_DEVICEINFO_PROCESSSTATUS_H_ */
 
 
/** @} */
/** @} */