@ohos.net.statistics (Traffic Management)

The statistics module provides APIs to query real-time or historical data traffic by the specified network interface card (NIC) or user ID (UID).

NOTE The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import statistics from "@ohos.net.statistics";

statistics.getIfaceRxBytes¹⁰⁺

getIfaceRxBytes(nic: string, callback: AsyncCallback<number>): void;

Obtains the real-time downlink data traffic of the specified NIC. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getIfaceRxBytes("wlan0", (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getIfaceRxBytes¹⁰⁺

getIfaceRxBytes(nic: string): Promise<number>;

Obtains the real-time downlink data traffic of the specified NIC. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time downlink data traffic of the NIC in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getIfaceRxBytes("wlan0").then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getIfaceTxBytes¹⁰⁺

getIfaceTxBytes(nic: string, callback: AsyncCallback<number>): void;

Obtains the real-time uplink data traffic of the specified NIC. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getIfaceTxBytes("wlan0", (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getIfaceTxBytes¹⁰⁺

getIfaceTxBytes(nic: string): Promise<number>;

Obtains the real-time uplink data traffic of the specified NIC. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time uplink data traffic of the NIC in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getIfaceTxBytes("wlan0").then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getCellularRxBytes¹⁰⁺

getCellularRxBytes(callback: AsyncCallback<number>): void;

Obtains the real-time downlink data traffic of a cellular network. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getCellularRxBytes((error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getCellularRxBytes¹⁰⁺

getCellularRxBytes(): Promise<number>;

Obtains the real-time downlink data traffic of a cellular network. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time downlink data traffic of the cellular network in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getCellularRxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getCellularTxBytes¹⁰⁺

getCellularTxBytes(callback: AsyncCallback<number>): void;

Obtains the real-time uplink data traffic of a cellular network. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getCellularTxBytes((error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getCellularTxBytes¹⁰⁺

getCellularTxBytes(): Promise<number>;

Obtains the real-time uplink data traffic of a cellular network. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time uplink data traffic of the cellular network in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getCellularTxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getAllRxBytes¹⁰⁺

getAllRxBytes(callback: AsyncCallback<number>): void;

Obtains the real-time downlink data traffic of all NICs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';
import { BusinessError } from '@ohos.base';

statistics.getAllRxBytes((error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getAllRxBytes¹⁰⁺

getAllRxBytes(): Promise<number>;

Obtains the real-time downlink data traffic of all NICs. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time downlink data traffic of all NICs in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getCellularRxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getAllTxBytes¹⁰⁺

getAllTxBytes(callback: AsyncCallback<number>): void;

Obtains the real-time uplink data traffic of all NICs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getAllTxBytes((error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getAllTxBytes¹⁰⁺

getAllTxBytes(): Promise<number>;

Obtains the real-time uplink data traffic of all NICs. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time uplink data traffic of all NICs in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getAllTxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getUidRxBytes¹⁰⁺

getUidRxBytes(uid: number, callback: AsyncCallback<number>): void;

Obtains the real-time downlink data traffic of the specified application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getUidRxBytes(20010038, (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getUidRxBytes¹⁰⁺

getUidRxBytes(uid: number): Promise<number>;

Obtains the real-time downlink data traffic of the specified application. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time downlink data traffic of the application in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getUidRxBytes(20010038).then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getUidTxBytes¹⁰⁺

getUidTxBytes(uid: number, callback: AsyncCallback<number>): void;

Obtains the real-time uplink data traffic of the specified application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

statistics.getUidTxBytes(20010038, (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getUidTxBytes¹⁰⁺

getUidTxBytes(uid: number): Promise<number>;

Obtains the real-time uplink data traffic of the specified application. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value |Type|Description| |——–|——–| |Promise<number>|Promise used to return the result, which is the real-time uplink data traffic of the application in bytes.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

statistics.getUidTxBytes(20010038).then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.on(‘netStatsChange’)¹⁰⁺

on(type: ‘netStatsChange’, callback: Callback<{ iface: string, uid?: number }>): void

Subscribes to traffic change events.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

class IFace {
  iface: string = ""
  uid?: number = 0
}
statistics.on('netStatsChange', (data: IFace) => {
  console.log('on netStatsChange' + JSON.stringify(data));
});

statistics.off(‘netStatsChange’)¹⁰⁺

off(type: ‘netStatsChange’, callback?: Callback<{ iface: string, uid?: number }>): void;

Unsubscribes from traffic change events.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

class IFace {
  iface: string = ""
  uid?: number = 0
}
let callback: (data: IFace) => void = (data: IFace) => {
    console.log("on netStatsChange, iFace:" + data.iface + " uid: " + data.uid);
}
statistics.on('netStatsChange', callback);
// You can pass the callback of the on method to cancel listening for a certain type of callback. If you do not pass the callback, you will cancel listening for all callbacks.
statistics.off('netStatsChange', callback);
statistics.off('netStatsChange');

statistics.getTrafficStatsByIface¹⁰⁺

getTrafficStatsByIface(ifaceInfo: IfaceInfo, callback: AsyncCallback<NetStatsInfo>): void;

Obtains the historical data traffic of the specified NIC. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

let iFaceInfo: statistics.IfaceInfo

statistics.getTrafficStatsByIface(iFaceInfo, (error: BusinessError, statsInfo: statistics.NetStatsInfo) => {
  console.log(JSON.stringify(error));
  console.log(
    "getTrafficStatsByIface bytes of received = " +
    JSON.stringify(statsInfo.rxBytes)
  );
  console.log(
    "getTrafficStatsByIface bytes of sent = " +
    JSON.stringify(statsInfo.txBytes)
  );
  console.log(
    "getTrafficStatsByIface packets of received = " +
    JSON.stringify(statsInfo.rxPackets)
  );
  console.log(
    "getTrafficStatsByIface packets of sent = " +
    JSON.stringify(statsInfo.txPackets)
  );
});

statistics.getTrafficStatsByIface¹⁰⁺

getTrafficStatsByIface(ifaceInfo: IfaceInfo): Promise<NetStatsInfo>;

Obtains the historical data traffic of the specified NIC. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Return value |Type|Description| |——–|——–| |Promise<NetStatsInfo>|Promise used to return the result, which is the historical data traffic of the specified NIC.|

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics';

let iFaceInfo: statistics.IfaceInfo
statistics.getTrafficStatsByIface(iFaceInfo).then((statsInfo: statistics.NetStatsInfo) => {
  console.log(
    "getTrafficStatsByIface bytes of received = " +
    JSON.stringify(statsInfo.rxBytes)
  );
  console.log(
    "getTrafficStatsByIface bytes of sent = " +
    JSON.stringify(statsInfo.txBytes)
  );
  console.log(
    "getTrafficStatsByIface packets of received = " +
    JSON.stringify(statsInfo.rxPackets)
  );
  console.log(
    "getTrafficStatsByIface packets of sent = " +
    JSON.stringify(statsInfo.txPackets)
  );
});

statistics.getTrafficStatsByUid¹⁰⁺

getTrafficStatsByUid(uidInfo: UidInfo, callback: AsyncCallback<NetStatsInfo>): void;

Obtains the historical data traffic of the specified application. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

let uidInfo: statistics.UidInfo
uidInfo.uid = 20010037

statistics.getTrafficStatsByUid(
  uidInfo,
  (error: BusinessError, statsInfo: statistics.NetStatsInfo) => {
    console.log(JSON.stringify(error));
    console.log(
      "getTrafficStatsByUid bytes of received = " +
      JSON.stringify(statsInfo.rxBytes)
    );
    console.log(
      "getTrafficStatsByUid bytes of sent = " +
      JSON.stringify(statsInfo.txBytes)
    );
    console.log(
      "getTrafficStatsByUid packets of received = " +
      JSON.stringify(statsInfo.rxPackets)
    );
    console.log(
      "getTrafficStatsByUid packets of sent = " +
      JSON.stringify(statsInfo.txPackets)
    );
  }
);

statistics.getTrafficStatsByUid¹⁰⁺

getTrafficStatsByUid(uidInfo: UidInfo): Promise<NetStatsInfo>;

Obtains the historical data traffic of the specified application. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.GET_NETWORK_STATS

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

For details about the error codes, see Traffic Management Error Codes.

Example

import statistics from '@ohos.net.statistics'

let uidInfo: statistics.UidInfo
uidInfo.uid = 20010037

statistics.getTrafficStatsByUid(uidInfo).then((statsInfo: statistics.NetStatsInfo) => {
  console.log("getTrafficStatsByUid bytes of received = " + JSON.stringify(statsInfo.rxBytes));
  console.log("getTrafficStatsByUid bytes of sent = " + JSON.stringify(statsInfo.txBytes));
  console.log("getTrafficStatsByUid packets of received = " + JSON.stringify(statsInfo.rxPackets));
  console.log("getTrafficStatsByUid packets of sent = " + JSON.stringify(statsInfo.txPackets));
})

IfaceInfo¹⁰⁺

Defines the parameters for querying historical traffic of an NIC.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.Core

UidInfo¹⁰⁺

Defines the parameters for querying historical traffic of an application.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.Core

NetStatsInfo¹⁰⁺

Defines the historical traffic information.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.Core

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)