harmony 鸿蒙# @ohos.net.ethernet (Ethernet Connection Management)
# @ohos.net.ethernet (Ethernet Connection Management)
The ethernet module provides wired network capabilities, which allow users to set the IP address, subnet mask, gateway, and Domain Name System (DNS) server, and HTTP proxy of a wired network.
NOTE The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import ethernet from '@ohos.net.ethernet'
ethernet.setIfaceConfig9+
setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback<void>): void
Sets the network interface configuration. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permissions: ohos.permission.CONNECTIVITY_INTERNAL
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. |
ic | InterfaceConfiguration | Yes | Network interface configuration to set. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, the return result is empty. If the operation fails, an error code is returned. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201004 | Invalid Ethernet profile. |
2201005 | Device information does not exist. |
2201006 | Ethernet device not connected. |
2201007 | Ethernet failed to write user configuration information. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
let config: ethernet.InterfaceConfiguration = {
mode: 0,
ipAddr: "192.168.xx.xxx",
route: "192.168.xx.xxx",
gateway: "192.168.xx.xxx",
netMask: "255.255.255.0",
dnsServers: "1.1.1.1"
};
ethernet.setIfaceConfig("eth0", config, (error: BusinessError) => {
if (error) {
console.log("setIfaceConfig callback error = " + JSON.stringify(error));
} else {
console.log("setIfaceConfig callback ok");
}
});
ethernet.setIfaceConfig9+
setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise<void>
Sets the network interface configuration. This API uses a promise to return the result.
System API: This is a system API.
Required permissions: ohos.permission.CONNECTIVITY_INTERNAL
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. |
ic | InterfaceConfiguration | Yes | Network interface configuration to set. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. If the operation is successful, the return result is empty. If the operation fails, an error code is returned. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201004 | Invalid Ethernet profile. |
2201005 | Device information does not exist. |
2201006 | Ethernet device not connected. |
2201007 | Ethernet failed to write user configuration information. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
let config: ethernet.InterfaceConfiguration = {
mode: 0,
ipAddr: "192.168.xx.xxx",
route: "192.168.xx.xxx",
gateway: "192.168.xx.xxx",
netMask: "255.255.255.0",
dnsServers: "1.1.1.1"
};
const setConfigPromise = ethernet.setIfaceConfig("eth0", config);
setConfigPromise.then(() => {
console.log("setIfaceConfig promise ok");
}).catch((error: BusinessError) => {
console.log("setIfaceConfig promise error = " + JSON.stringify(error));
});
ethernet.getIfaceConfig9+
getIfaceConfig(iface: string, callback: AsyncCallback<InterfaceConfiguration>): void
Obtains the configuration of a network interface. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. |
callback | AsyncCallback<InterfaceConfiguration> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201005 | Device information does not exist. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.getIfaceConfig("eth0", (error: BusinessError, value: ethernet.InterfaceConfiguration) => {
if (error) {
console.log("getIfaceConfig callback error = " + JSON.stringify(error));
} else {
console.log("getIfaceConfig callback mode = " + JSON.stringify(value.mode));
console.log("getIfaceConfig callback ipAddr = " + JSON.stringify(value.ipAddr));
console.log("getIfaceConfig callback route = " + JSON.stringify(value.route));
console.log("getIfaceConfig callback gateway = " + JSON.stringify(value.gateway));
console.log("getIfaceConfig callback netMask = " + JSON.stringify(value.netMask));
console.log("getIfaceConfig callback dnsServers = " + JSON.stringify(value.dnsServers));
}
});
ethernet.getIfaceConfig9+
getIfaceConfig(iface: string): Promise<InterfaceConfiguration>
Obtains the configuration of a network interface. This API uses a promise to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. |
Return value
Type | Description |
---|---|
Promise<InterfaceConfiguration> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201005 | Device information does not exist. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.getIfaceConfig("eth0").then((data: ethernet.InterfaceConfiguration) => {
console.log("getIfaceConfig promise mode = " + JSON.stringify(data.mode));
console.log("getIfaceConfig promise ipAddr = " + JSON.stringify(data.ipAddr));
console.log("getIfaceConfig promise route = " + JSON.stringify(data.route));
console.log("getIfaceConfig promise gateway = " + JSON.stringify(data.gateway));
console.log("getIfaceConfig promise netMask = " + JSON.stringify(data.netMask));
console.log("getIfaceConfig promise dnsServers = " + JSON.stringify(data.dnsServers));
}).catch((error: BusinessError) => {
console.log("getIfaceConfig promise error = " + JSON.stringify(error));
});
ethernet.isIfaceActive9+
isIfaceActive(iface: string, callback: AsyncCallback<number>): void
Checks whether a network interface is active. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. If this parameter is left empty, the API checks for any active network interface. |
callback | AsyncCallback<number> | Yes | Callback used to return the result. The value 1 means that the network interface is active, 0 means that the network interface is inactive, and any other value means that an error has occurred. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201005 | Device information does not exist. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.isIfaceActive("eth0", (error: BusinessError, value: number) => {
if (error) {
console.log("whether2Activate callback error = " + JSON.stringify(error));
} else {
console.log("whether2Activate callback = " + JSON.stringify(value));
}
});
ethernet.isIfaceActive9+
isIfaceActive(iface: string): Promise<number>
Checks whether a network interface is active. This API uses a promise to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
iface | string | Yes | Interface name. If this parameter is left empty, the API checks for any active network interface. |
Return value
Type | Description |
---|---|
Promise<number> | Promise used to return the result. The value 1 means that the network interface is active, 0 means that the network interface is inactive, and any other value means that an error has occurred. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
2200001 | Invalid parameter value. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
2201005 | Device information does not exist. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.isIfaceActive("eth0").then((data: number) => {
console.log("isIfaceActive promise = " + JSON.stringify(data));
}).catch((error: BusinessError) => {
console.log("isIfaceActive promise error = " + JSON.stringify(error));
});
ethernet.getAllActiveIfaces9+
getAllActiveIfaces(callback: AsyncCallback<Array<string>>): void
Obtains the list of all active network interfaces. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.getAllActiveIfaces((error: BusinessError, value: string[]) => {
if (error) {
console.log("getAllActiveIfaces callback error = " + JSON.stringify(error));
} else {
console.log("getAllActiveIfaces callback value.length = " + JSON.stringify(value.length));
for (let i = 0; i < value.length; i++) {
console.log("getAllActiveIfaces callback = " + JSON.stringify(value[i]));
}
}
});
ethernet.getAllActiveIfaces9+
getAllActiveIfaces(): Promise<Array<string>>
Obtains the list of all active network interfaces. This API uses a promise to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Return value
Type | Description |
---|---|
Promise<Array<string>> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
2200002 | Operation failed. Cannot connect to service. |
2200003 | System internal error. |
Example
import ethernet from '@ohos.net.ethernet'
import { BusinessError } from '@ohos.base'
ethernet.getAllActiveIfaces().then((data: string[]) => {
console.log("getAllActiveIfaces promise data.length = " + JSON.stringify(data.length));
for (let i = 0; i < data.length; i++) {
console.log("getAllActiveIfaces promise = " + JSON.stringify(data[i]));
}
}).catch((error:BusinessError) => {
console.log("getAllActiveIfaces promise error = " + JSON.stringify(error));
});
ethernet.on(‘interfaceStateChange’)10+
on(type: ‘interfaceStateChange’, callback: Callback<{ iface: string, active: boolean }>): void
Registers an observer for NIC hot swap events. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type. The value is interfaceStateChange. |
callback | AsyncCallback<{ iface: string, active: boolean }> | Yes | Callback used to return the result. iface: NIC name. active: whether the NIC is active. The value true indicates that the NIC is active, and the value false indicates the opposite. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
Example
import ethernet from '@ohos.net.ethernet'
ethernet.on('interfaceStateChange', (data: object) => {
console.log('on interfaceSharingStateChange: ' + JSON.stringify(data));
});
ethernet.off(‘interfaceStateChange’)10+
off(type: ‘interfaceStateChange’, callback?: Callback<{ iface: string, active: boolean }>): void
Unregisters the observer for NIC hot swap events. This API uses an asynchronous callback to return the result.
System API: This is a system API.
Required permission: ohos.permission.GET_NETWORK_INFO
System capability: SystemCapability.Communication.NetManager.Ethernet
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type. The value is interfaceStateChange. |
callback | AsyncCallback<{ iface: string, active: boolean }> | No | Callback used to return the result. iface: NIC name. active: whether the NIC is active. The value true indicates that the NIC is active, and the value false indicates the opposite. |
Error codes
ID | Error Message |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
Example
import ethernet from '@ohos.net.ethernet'
ethernet.off('interfaceStateChange');
InterfaceConfiguration9+
Defines the network configuration for the Ethernet connection.
System API: This is a system API.
System capability: SystemCapability.Communication.NetManager.Ethernet
Name | Type | Mandatory | Description |
---|---|---|---|
mode | IPSetMode | Yes | Configuration mode of the Ethernet connection. |
ipAddr | string | Yes | Static IP address of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in Dynamic Host Configuration Protocol (DHCP) mode. |
route | string | Yes | Route of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in DHCP mode. |
gateway | string | Yes | Gateway of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in DHCP mode. |
netMask | string | Yes | Subnet mask of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in DHCP mode. |
dnsServers | string | Yes | DNS server addresses of the Ethernet connection. The value must be an IPv4 address. This parameter does not need to be configured in DHCP mode. Multiple addresses are separated by commas (,). |
httpProxy10+ | HttpProxy | No | HTTP proxy of the Ethernet connection. By default, no proxy is configured. |
IPSetMode9+
Defines the configuration mode of the Ethernet connection.
System API: This is a system API.
System capability: SystemCapability.Communication.NetManager.Ethernet
Name | Value | Description |
---|---|---|
STATIC | 0 | Static configuration. |
DHCP | 1 | Dynamic configuration. |
你可能感兴趣的鸿蒙文章
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)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦