@ohos.net.statistics (Traffic Management)

The statistics module provides APIs to obtain the real-time uplink and downlink data traffic of the specified NIC.

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 '@kit.NetworkKit';

statistics.getAllRxBytes().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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

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 '@kit.NetworkKit';

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

statistics.getSockfdRxBytes¹¹⁺

getSockfdRxBytes(sockfd: number, callback: AsyncCallback<number>): void;

Obtains the downlink data traffic (in bytes) of the specified socket. 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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

let sockfd = 50; // FD of the socket you created.
statistics.getSockfdRxBytes(sockfd, (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getSockfdRxBytes¹¹⁺

getSockfdRxBytes(sockfd: number): Promise<number>;

Obtains the downlink data traffic (in bytes) of the specified socket. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

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

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

let sockfd = 50; // FD of the socket you created.
statistics.getSockfdRxBytes(sockfd).then((stats: number) => {
  console.log(JSON.stringify(stats));
}).catch((err: BusinessError) => {
  console.error(JSON.stringify(err));
});

statistics.getSockfdTxBytes¹¹⁺

getSockfdTxBytes(sockfd: number, callback: AsyncCallback<number>): void;

Obtains the uplink data traffic (in bytes) of the specified socket. 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 '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

let sockfd = 50; // FD of the socket you created.
statistics.getSockfdTxBytes(sockfd, (error: BusinessError, stats: number) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getSockfdTxBytes¹¹⁺

getSockfdTxBytes(sockfd: number): Promise<number>;

Obtains the uplink data traffic (in bytes) of the specified socket. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Return value

Error codes

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

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { statistics } from '@kit.NetworkKit';

let sockfd = 50; // FD of the socket you created.
statistics.getSockfdTxBytes(sockfd).then((stats: number) => {
  console.log(JSON.stringify(stats));
}).catch((err: BusinessError) => {
  console.error(JSON.stringify(err));
});

NetBearType¹²⁺

type NetBearType = connection.NetBearType

Enumerates network types.

System capability: SystemCapability.Communication.NetManager

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Network Kit

harmony 鸿蒙NetConn_ConnectionProperties

harmony 鸿蒙NetConn_HttpProxy

harmony 鸿蒙NetConn_NetAddr

harmony 鸿蒙NetConn_NetCapabilities

harmony 鸿蒙NetConn_NetConnCallback

harmony 鸿蒙NetConn_NetHandle

harmony 鸿蒙NetConn_NetHandleList

harmony 鸿蒙NetConn_NetSpecifier

harmony 鸿蒙NetConn_Route