@ohos.net.statistics (流量管理)

流量管理模块提供获取指定网卡实时上行、下行流量等能力。

说明：

本模块首批接口从 API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

statistics.getIfaceRxBytes¹⁰⁺

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

获取指定网卡实时下行流量，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

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

statistics.getIfaceRxBytes¹⁰⁺

getIfaceRxBytes(nic: string): Promise<number>

获取指定网卡实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回网卡实时下行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

获取指定网卡实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

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

statistics.getIfaceTxBytes¹⁰⁺

getIfaceTxBytes(nic: string): Promise<number>

获取指定网卡实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回网卡实时上行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

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

statistics.getCellularRxBytes¹⁰⁺

getCellularRxBytes(callback: AsyncCallback<number>): void

获取蜂窝实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getCellularRxBytes¹⁰⁺

getCellularRxBytes(): Promise<number>

获取蜂窝实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回蜂窝实时下行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getCellularTxBytes¹⁰⁺

getCellularTxBytes(callback: AsyncCallback<number>): void

获取蜂窝实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getCellularTxBytes¹⁰⁺

getCellularTxBytes(): Promise<number>

获取蜂窝实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回蜂窝实时上行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getAllRxBytes¹⁰⁺

getAllRxBytes(callback: AsyncCallback<number>): void

获取所有网卡实时下行流量，使用 callback 方式作为异步方法。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getAllRxBytes¹⁰⁺

getAllRxBytes(): Promise<number>

获取所有网卡实时下行流量，使用 Promise 方式作为异步方法。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Communication.NetManager.Core

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回所有网卡实时下行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getAllTxBytes¹⁰⁺

getAllTxBytes(callback: AsyncCallback<number>): void

获取所有网卡实时上行流量，使用 callback 方式作为异步方法。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getAllTxBytes¹⁰⁺

getAllTxBytes(): Promise<number>

获取所有网卡实时上行流量，使用 Promise 方式作为异步方法。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.Communication.NetManager.Core

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回所有网卡实时上行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码。

示例：

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

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

statistics.getUidRxBytes¹⁰⁺

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

获取指定应用实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

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

statistics.getUidRxBytes¹⁰⁺

getUidRxBytes(uid: number): Promise<number>

获取指定应用实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回指定应用实时下行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

获取指定应用实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

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

statistics.getUidTxBytes¹⁰⁺

getUidTxBytes(uid: number): Promise<number>

获取指定应用实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值： |类型|说明| |——–|——–| |Promise<number>|以 Promise 形式返回获取结果。返回指定应用实时上行流量(单位:字节)。|

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

获取指定socket的下行流量信息，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到。
statistics.getSockfdRxBytes(sockfd, (error: BusinessError, stats: number) => {
  console.error(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getSockfdRxBytes¹¹⁺

getSockfdRxBytes(sockfd: number): Promise<number>

获取指定socket的下行流量信息，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到。
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

获取指定socket的上行流量信息，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到。
statistics.getSockfdTxBytes(sockfd, (error: BusinessError, stats: number) => {
  console.error(JSON.stringify(error));
  console.log(JSON.stringify(stats));
});

statistics.getSockfdTxBytes¹¹⁺

getSockfdTxBytes(sockfd: number): Promise<number>

获取指定socket的上行流量信息，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见流量管理错误码和通用错误码。

示例：

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

let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到。
statistics.getSockfdTxBytes(sockfd).then((stats: number) => {
  console.log(JSON.stringify(stats));
}).catch((err: BusinessError) => {
  console.error(JSON.stringify(err));
});

NetBearType¹²⁺

type NetBearType = connection.NetBearType

网络类型。

系统能力：SystemCapability.Communication.NetManager.Core

你可能感兴趣的鸿蒙文章

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