RDK Documentation (Open Sourced RDK Components)
netsrvmgrUtiles.h File Reference

The header file provides components netSrvMgrUtiles information APIs. More...

#include <iostream>
#include "logging.h"
Include dependency graph for netsrvmgrUtiles.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MAC_ADDR_BUFF_LEN   18
 
#define SYSTEM_COMMAND_SHELL_NOT_FOUND   127
 
#define SYSTEM_COMMAND_SHELL_SUCESS   23
 
#define SYSTEM_COMMAND_ERROR   -1
 
#define BUFFER_SIZE_SCRIPT_OUTPUT   512
 

Functions

bool netSrvMgrUtiles::getMacAddress_IfName (const char *ifName_in, char macAddress_out[18])
 This function is used to get the MAC address for the provided interface. More...
 
void netSrvMgrUtiles::triggerDhcpLease (const char *operation, const char *interface)
 This function trigger the process by which the DHCP client renews or updates its IP address configuration data with the DHCP server. More...
 
void netSrvMgrUtiles::triggerDhcpRenew (const char *interface=NULL)
 
void netSrvMgrUtiles::triggerDhcpReleaseAndRenew (const char *interface)
 
bool netSrvMgrUtiles::getRouteInterface (char *devname)
 This function retrieves information about the active routing interface. More...
 
bool netSrvMgrUtiles::readDevFile (char *deviceName)
 This function gets the device interface type(Ethernet/MOCA/WIFI) of the input device name. This function reads the device interface type from device properties file. More...
 
char netSrvMgrUtiles::getAllNetworkInterface (char *devAllInterface)
 This function parse all the device interface details and gives all the network interface device name in the output buffer. This function also returns the total network interface count. More...
 
bool netSrvMgrUtiles::getCurrentTime (char *currTime, const char *timeFormat)
 This function retrieves the current time using the requested format specifier. More...
 
bool netSrvMgrUtiles::checkInterfaceActive (char *interfaceName)
 This function returns the Ethernet active status of the interface, if finds the status from interface status file. More...
 
bool netSrvMgrUtiles::getSTBip (char *stbip, bool *isIpv6)
 This function is used to get STB IP address and its IP version. More...
 
bool netSrvMgrUtiles::getInterfaceConfig (const char *ifName, const unsigned int family, char *interfaceIp, char *netMask)
 This function is used to get Interface IP address and on which interface. More...
 
bool netSrvMgrUtiles::getDNSip (const unsigned int family, char *primaryDNS, char *secondaryDNS)
 This function is used to get Interface IP address and on which interface. More...
 
bool netSrvMgrUtiles::getSTBip_family (char *stbip, const char *family)
 
bool netSrvMgrUtiles::getRouteInterfaceType (char *devname)
 This function gets the active interface device type(Ethernet/MOCA/WIFI). More...
 
bool netSrvMgrUtiles::chk_ipaddr_linklocal (const char *stbip, unsigned int family)
 This function checks whether IP string(IPv4 and IPv6) is link local address or not. More...
 
bool netSrvMgrUtiles::currentActiveInterface (char *currentInterface)
 This function is used to get the current active interface(WIFI/MOCA). More...
 
bool netSrvMgrUtiles::check_global_v6_based_macaddress (std::string ipv6Addr, std::string macAddr)
 This function checks whether the input ipv6 address is based on specified mac address. More...
 
bool netSrvMgrUtiles::check_global_v6_ula_address (std::string ipv6Addr)
 This function checks whether the input ipv6 address is Unique Local Address. More...
 
bool netSrvMgrUtiles::getCommandOutput (const char *command, char *output_buffer, size_t output_buffer_size)
 This function is used to get the output of running the specified command. More...
 
bool netSrvMgrUtiles::getNetMask_IfName (const char *ifName_in, const unsigned int, char *netMask_out)
 This function is used to get the NetMask address for the provided interface. More...
 
bool netSrvMgrUtiles::isIPv4AddressScopeDocumentation (const std::string &ipv4_address)
 This function checks if the input ipv4 address is a unicast address reserved for documentation. More...
 

yes

The header file provides components netSrvMgrUtiles information APIs.

Definition in file netsrvmgrUtiles.h.