Ethernet Connection

Overview

The Ethernet Connection module allows a device to access the Internet through a network cable. After a device is connected to the Ethernet through a network cable, the device can obtain a series of network attributes, such as the dynamically allocated IP address, subnet mask, gateway, and DNS. You can manually configure and obtain the network attributes of the device in static mode.

NOTE To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see sms API Reference.

Constraints

• Programming language: C++ and JS
• System: Linux kernel
• 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.

Scenario

Typical application scenarios of Ethernet connection are as follows:

• Dynamically assigning a series of network attributes, such as the IP address, subnet mask, gateway, and DNS in DHCP mode to enable network access
• Configuring a series of network attributes, such as the IP address, subnet mask, gateway, and DNS, in static mode to enable network access.

The following describes the development procedure specific to each application scenario.

Available APIs

For the complete list of APIs and example code, see Ethernet Connection.

Ethernet Connection – DHCP Mode

1. Use a network cable to connect the device to a network port.
2. Import the ethernet namespace from @ohos.net.ethernet.
3. Call getAllActiveIfaces to obtain the list of all active network ports, for example, eth0 and eth1.
4. Call isIfaceActive in user mode to check whether the eth0 port is active.
5. Call getIfaceConfig in user mode to obtain the static network attributes of the eth0 port. By default, an unconfigured Ethernet network uses the DHCP mode, in which the Ethernet network obtains the automatically assigned network attributes.

// Import the ethernet namespace from @ohos.net.ethernet.
import ethernet from '@ohos.net.ethernet';
import { BusinessError } from '@ohos.base';

// Call getAllActiveIfaces to obtain the list of all active network ports.
ethernet.getAllActiveIfaces((error: BusinessError, data: string[]) => {
  if (error) {
    console.log("getAllActiveIfaces callback error = " + error);
  } else {
    console.log("getAllActiveIfaces callback data.length = " + data.length);
    for (let i = 0; i < data.length; i++) {
      console.log("getAllActiveIfaces callback = " + data[i]);
    }
  }
});

// Call isIfaceActive to check whether the specified network port is active.
ethernet.isIfaceActive("eth0", (error: BusinessError, data: number) => {
  if (error) {
    console.log("isIfaceActive callback error = " + error);
  } else {
    console.log("isIfaceActive callback = " + data);
  }
});

// Call getIfaceConfig to obtain the network attributes of the specified Ethernet network.
ethernet.getIfaceConfig("eth0", (error: BusinessError, data: ethernet.InterfaceConfiguration) => {
  if (error) {
    console.log("getIfaceConfig  callback error = " + error);
  } else {
    console.log("getIfaceConfig callback mode = " + data.mode);
    console.log("getIfaceConfig callback ipAddr = " + data.ipAddr);
    console.log("getIfaceConfig callback routeAddr = " + data.routeAddr);
    console.log("getIfaceConfig callback gateAddr = " + data.gateAddr);
    console.log("getIfaceConfig callback maskAddr = " + data.maskAddr);
    console.log("getIfaceConfig callback dns0Addr = " + data.dns0Addr);
    console.log("getIfaceConfig callback dns1Addr = " + data.dns1Addr);
  }
});

Ethernet Connection – Static Mode

How to Develop

1. Use a network cable to connect the device to a network port.
2. Import the ethernet namespace from @ohos.net.ethernet.
3. Call getAllActiveIfaces in user mode to obtain the list of all active network ports, for example, eth0 and eth1.
4. Call isIfaceActive in user mode to check whether the eth0 port is active.
5. Call setIfaceConfig in user mode to set the eth0 port to the static mode, in which you need to manually assign the network attributes (including the IP address, subnet mask, gateway, and DNS).
6. Call getIfaceConfig in user mode to obtain the static network attributes of the eth0 port.

// Import the ethernet namespace from @ohos.net.ethernet.
import ethernet from '@ohos.net.ethernet';
import { BusinessError } from '@ohos.base';

// Call getAllActiveIfaces to obtain the list of all active network ports.
ethernet.getAllActiveIfaces((error: BusinessError, data: string[]) => {
  if (error) {
    console.log("getAllActiveIfaces callback error = " + error);
  } else {
    console.log("getAllActiveIfaces callback data.length = " + data.length);
    for (let i = 0; i < data.length; i++) {
      console.log("getAllActiveIfaces callback = " + data[i]);
    }
  }
});

// Call isIfaceActive to check whether the specified network port is active.
ethernet.isIfaceActive("eth0", (error: BusinessError, data: number) => {
  if (error) {
    console.log("isIfaceActive callback error = " + error);
  } else {
    console.log("isIfaceActive callback = " + data);
  }
});

let ethernetParam: ethernet.InterfaceConfiguration = {
  mode: ethernet.IPSetMode.STATIC,
  ipAddr: "192.168.xx.xx",
  routeAddr: "192.168.xx.xx",
  gateAddr: "192.168.xx.xx",
  maskAddr: "255.255.xx.xx",
  dnsAddr0: "1.1.xx.xx",
  dnsAddr1: "2.2.xx.xx"
}

// Call setIfaceConfig to configure the network attributes of the specified Ethernet network.
ethernet.setIfaceConfig("eth0", ethernetParam, (error: BusinessError) => {
  if (error) {
    console.log("setIfaceConfig callback error = " + error);
  } else {
    console.log("setIfaceConfig callback ok ");
  }
});

// Call getIfaceConfig to obtain the network attributes of the specified Ethernet network.
ethernet.getIfaceConfig("eth0", (error: BusinessError, data: ethernet.InterfaceConfiguration) => {
  if (error) {
    console.log("getIfaceConfig  callback error = " + error);
  } else {
    console.log("getIfaceConfig callback mode = " + data.mode);
    console.log("getIfaceConfig callback ipAddr = " + data.ipAddr);
    console.log("getIfaceConfig callback routeAddr = " + data.routeAddr);
    console.log("getIfaceConfig callback gateAddr = " + data.gateAddr);
    console.log("getIfaceConfig callback maskAddr = " + data.maskAddr);
    console.log("getIfaceConfig callback dns0Addr = " + data.dns0Addr);
    console.log("getIfaceConfig callback dns1Addr = " + data.dns1Addr);
  }
});

Subscribes the status change of network device interfaces.

How to Develop

1. Import the ethernet namespace from @ohos.net.ethernet.
2. Call the on() method to subscribe to interfaceStateChange events. It is up to you whether to listen for interfaceStateChange events.
3. Check whether an interfaceStateChange event is triggered when the interface state changes.
4. Call the off() method to unsubscribe from interfaceStateChange events.

// Import the ethernet namespace from @ohos.net.ethernet.
import ethernet from '@ohos.net.ethernet';

// Subscribe to interfaceStateChange events.
class EthernetData{
  iface: string = ""
  active: boolean = false
}

ethernet.on('interfaceStateChange', (data: EthernetData) => {
  console.log(JSON.stringify(data));
});

// Unsubscribe from interfaceStateChange events.
ethernet.off('interfaceStateChange');

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Connectivity

harmony 鸿蒙HTTP Data Request

harmony 鸿蒙IPC & RPC Development Guidelines

harmony 鸿蒙IPC & RPC Overview

harmony 鸿蒙Network Connection Management

harmony 鸿蒙mDNS Management

harmony 鸿蒙Network Management Overview

harmony 鸿蒙Network Sharing

harmony 鸿蒙Traffic Management

harmony 鸿蒙VPN Management