libmcm  1.4.0
A client library for Moxa Connection Management
mcm-datausage.h File Reference
#include "mcm-base-info.h"

Go to the source code of this file.

Functions

int mcm_datausage_get_iface_total (char *interfaceName, mcm_datausage_info *traffic_info)
 A helper function to get traffic. More...
 
int mcm_datausage_get_iface_period (char *interfaceName, char *databegin, char *dataend, mcm_datausage_info *traffic_info)
 A helper function to get traffic for a period of time. More...
 
int mcm_datausage_get_iface_from (char *interfaceName, char *databegin, mcm_datausage_info *traffic_info)
 A helper function to get traffic for a period of time. More...
 
int mcm_datausage_reset (char *interfaceName)
 A helper function to reset traffic data and restart monitor. More...
 

Detailed Description

This library is for Moxa Connection Management

Function Documentation

◆ mcm_datausage_get_iface_from()

int mcm_datausage_get_iface_from ( char *  interfaceName,
char *  databegin,
mcm_datausage_info traffic_info 
)

A helper function to get traffic for a period of time.

Parameters
interfaceName(input) Interface name.
databegin(input) Start date. expected date format YYYY-MM-DD HH:MM or YYYY-MM-DD.
traffic_info(output) A datausage infomation structure.
Returns
If get total traffic success return 0. If fail, return error number.

◆ mcm_datausage_get_iface_period()

int mcm_datausage_get_iface_period ( char *  interfaceName,
char *  databegin,
char *  dataend,
mcm_datausage_info traffic_info 
)

A helper function to get traffic for a period of time.

Parameters
interfaceName(input) Interface name.
databegin(input) Start date. expected date format YYYY-MM-DD HH:MM or YYYY-MM-DD.
dataend(input) End date. expected date format YYYY-MM-DD HH:MM or YYYY-MM-DD.
traffic_info(output) A datausage infomation structure.
Returns
If get total traffic success return 0. If fail, return error number.

◆ mcm_datausage_get_iface_total()

int mcm_datausage_get_iface_total ( char *  interfaceName,
mcm_datausage_info traffic_info 
)

A helper function to get traffic.

Parameters
interfaceName(input) Interface name.
traffic_info(output) A datausage infomation structure.
Returns
If get total traffic success return 0. If fail, return error number.

◆ mcm_datausage_reset()

int mcm_datausage_reset ( char *  interfaceName)

A helper function to reset traffic data and restart monitor.

Returns
If reset success return 0. If fail, return error number.