Device_IP_Interface_IPv4Address.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_IP_Interface_IPv4Address.h
 * @brief The header file provides TR069 device IPv4 interface address information APIs.
 */
 
/**
 * @defgroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS TR-069 Object (Device.IP.Interface.IPv4Address)
 *
 * @par IPv4 address table
 * Entries are auto-created and auto-deleted as IP addresses are added and deleted via
 * - DHCP
 * - auto-IP or
 * - IPCP
 * Static entries are created and configured by the ACS.
 * - At most one entry in this table regardless of whether or not it is enabled can exist with a
 * given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value
 * for Alias such that the new entry does not conflict with any existing entries.
 * - At most one enabled entry in this table can exist with the same values for IPAddress and SubnetMask.
 *
 * @ingroup TR69_HOSTIF_DEVICE_IP
 *
 * @defgroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS_API TR-069 Object (Device.IP.Interface.IPv4Address) Public APIs
 * Describe the details about TR-069 Device IPv4 Interface address APIs specifications.
 * @ingroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS
 *
 * @defgroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS_CLASSES TR-069 Object (Device.IP.Interface.IPv4Address) Public Classes
 * Describe the details about classes used in TR069 Device IPv4 Interface address.
 * @ingroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS
 *
 * @defgroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS_STRUCT TR-069 Object (Device.IP.Interface.IPv4Address) Public DataStructure
 * Describe the details about data structure used in TR069 Device IPv4 Interface address.
 * @ingroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS
 */
 
 
/**
* @defgroup tr69hostif
* @{
* @defgroup hostif
* @{
**/
 
 
#ifndef DEVICE_IP_INTERFACE_IPV4ADDRESS_H_
#define DEVICE_IP_INTERFACE_IPV4ADDRESS_H_
 
/*****************************************************************************
 * TR069-SPECIFIC INCLUDE FILES
 *****************************************************************************/
#include "hostIf_main.h"
#include "hostIf_tr69ReqHandler.h"
#include "hostIf_utils.h"
#include "hostIf_updateHandler.h"
#include <net/if.h>
 
 
/** @defgroup TR_069_DEVICE_IP_INTERFACE_IPV4ADDRESS_API TR-069 Device.IP.Interface.IPv4Address object API.
 *  @ingroup TR_069_DEVICE_IP_INTERFACE_API
 *
 *  The Device.IP.Interface.IPv4Address is the table of IPv4 Addresses.  Entries are
 *  auto-created and auto-deleted as IP addresses are added and deleted via DHCP,
 *  auto-IP, or IPCP. Static entries are created and configured by the ACS.
 *
 *  @note    <ul>
 *               <li>At most one entry in this table (regardless of whether or not it
 *               is enabled) can exist with a given value for Alias. On creation of a
 *               new table entry, the CPE MUST choose an initial value for Alias such
 *               that the new entry does not conflict with any existing entries.</li>
 *
 *               <li>At most one enabled entry in this table can exist with the same
 *               values for IPAddress and SubnetMask.</li>
 *           </ul>
 *
 */
 
/** @addtogroup TR_069_DEVICE_IP_INTERFACE_IPV4ADDRESS_GETTER_API TR-069 Device.IP.Interface.IPv4Address Getter API.
 *  @ingroup TR_069_DEVICE_IP_INTERFACE_IPV4ADDRESS_API
 *
 *  \section dev_ip_ipv4address_getter TR-069 Device.IP.Interface.IPv4Address object Getter API
 *
 *  This is the getter group of API for the <b>Device.IP.Interface.{i}.IPv4Address.{j}</b> object.
 *
 *  The interface for all functions is identical and is described here.
 *
 *  @param[in]   *name     This is the complete path name of the parameter extracted from
 *                         soap message, e.g. ::get_Device_IP_Interface_IPv4Address_Enable.
 *                         In this case, the path is "Device.IP.Interface.{i}.IPv4Address.{j}.Enable".
 *  @param[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)
 *  @param[out]  *value    This is the value of the parameter requested by the ACS.
 *                         (see paramaccess.h)
 *
 *  @return The status of the operation.
 *  @retval OK            If parameter requested was successfully fetched. (Same as <b>NO_ERROR</b>).
 *  @retval NO_ERROR      If parameter requested was successfully fetched. (Same as <b>OK</b>).
 *  @retval DIAG_ERROR    Diagnostic error.
 *  @retval ERR_???       Appropriate error value otherwise (see dimark_globals.h).
 *
 *  @todo Clarify description of DIAG_ERROR.
 *
 *  @{
 */
 
/**
 * @brief This class provides the hostIf IPv4 interface address for getting  interface address information.
 * @ingroup TR69_HOSTIF_DEVICE_IP_IPv4_INTERFACE_ADDRESS_CLASSES
 */
class hostIf_IPv4Address {
 
    static  GHashTable  *ifHash;
    static GMutex *m_mutex;
 
    int dev_id;
    char nameOfInterface[IF_NAMESIZE];
 
    bool bCalledEnable;
    bool bCalledStatus;
    bool bCalledIPAddress;
    bool bCalledSubnetMask;
    bool bCalledAddressingType;
 
    bool backupEnable;
    char backupStatus[BUFF_LENGTH_16];
//    char backupAlias[TR69HOSTIFMGR_MAX_PARAM_LEN];
    char backupIPAddress[BUFF_LENGTH_64];
    char backupSubnetMask[BUFF_LENGTH_64];
    char backupAddressingType[BUFF_LENGTH_16];
 
    hostIf_IPv4Address(int dev_id);
    ~hostIf_IPv4Address() {};
 
    void refreshInterfaceName ();
    int getIPv4AddressAndMask (int instance, struct in_addr& in_address, struct in_addr& in_mask);
    static bool isLinkLocalAddress (const struct in_addr& in_address);
    bool hasPhysicalInterfaceAs (char* phy_if_name);
    int setIpOrMask(int interfaceNo, char *value, const char* ipOrMask);
 
public:
 
    static hostIf_IPv4Address* getInstance(int dev_id);
    static GList* getAllInstances();
    static void closeInstance(hostIf_IPv4Address*);
    static void closeAllInstances();
 
    static void getLock();
    static void releaseLock();
 
    int handleGetMsg (const char* pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t* stMsgData);
    int handleSetMsg (const char* pSubSetting, int subInstanceNumber, HOSTIF_MsgData_t* stMsgData);
 
    /**
     * @brief    Get status (enabled/disabled) of IPv4 address.
     *
     * This function provides the value (<tt>true/false</tt>) of the Enable status of this
     * IPv4 address.
     *
     * See @ref dev_ip_ipv4address_getter
     *
     */
    int get_IPv4Address_Enable(HOSTIF_MsgData_t *stMsgData,int subInstanceNo, bool *pChanged = NULL);
 
    int get_IPv4Address_Status(HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged = NULL);
 
    int get_IPv4Address_Alias(HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged = NULL);
 
    int get_IPv4Address_IPAddress(HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged = NULL);
 
    int get_IPv4Address_SubnetMask(HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged = NULL);
 
    int get_IPv4Address_AddressingType(HOSTIF_MsgData_t *stMsgData, int subInstanceNo, bool *pChanged = NULL);
 
    /* End of TR_069_DEVICE_IP_IPV4ADDRESS_GETTER_API doxygen group */
    /**
     * @}
     */
 
    /** @addtogroup TR_069_DEVICE_IP_IPV4ADDRESS_SETTER_API TR-069 Device.IP.Interface.IPv4Address Setter API.
     *  @ingroup TR_069_DEVICE_IP_INTERFACE_IPV4ADDRESS_API
     *
     *  \section dev_ip_ipv4address_setter TR-069 Device.IP.Interface.IPv4Address object Setter API
     *
     *  This is the setter group of API for the <b>Device.IP.Interface.{i}.IPv4Address.{j}</b> object.
     *
     *  The interface for all functions is identical and is described here.
     *
     *  @param[in]   *name     This is the complete path name of the parameter extracted from
     *                         soap message, e.g. ::set_Device_IP_Interface_IPv4Address_Enable.
     *                         In this case, the path is "Device.IP.Interface.{i}.IPv4Address.{j}.Enable".
     *  @param[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)
     *  @param[in]   *value    This is the value to which the parameter requested by the ACS
     *                         must be set.
     *                         (see paramaccess.h)
     *
     *  @return The status of the operation.
     *  @retval OK            If parameter requested was successfully fetched. (Same as <b>NO_ERROR</b>).
     *  @retval NO_ERROR      If parameter requested was successfully fetched. (Same as <b>OK</b>).
     *  @retval DIAG_ERROR    Diagnostic error.
     *  @retval ERR_???       Appropriate error value otherwise (see dimark_globals.h).
     *
     *  @todo Clarify description of DIAG_ERROR.
     *
     *  @{
     */
 
    int set_IPv4Address_Enable(HOSTIF_MsgData_t *stMsgData, int subInstanceNo);
 
    int set_IPv4Address_Alias(HOSTIF_MsgData_t *stMsgData, int subInstanceNo);
 
    int set_IPv4Address_IPAddress(HOSTIF_MsgData_t *stMsgData, int subInstanceNo);
 
    int set_IPv4Address_SubnetMask(HOSTIF_MsgData_t *stMsgData, int subInstanceNo);
 
    /* End of TR_069_DEVICE_IP_IPV4ADDRESS_SETTER_API doxygen group */
    /**
     * @}
     */
};
 
 
#endif /* DEVICE_IP_INTERFACE_IPV4ADDRESS_H_ */
 
 
/** @} */
/** @} */