subject-two/ohos/so/@ohos.net.ethernet.d.ts

/*
 * Copyright (C) 2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {AsyncCallback, Callback} from "./basic";

/**
 * Provides interfaces to manage ethernet.
 *
 * @since 9
 * @syscap SystemCapability.Communication.NetManager.Ethernet
 */
declare namespace ethernet {
  /**
   * Get the specified network interface information.
   *
   * @param iface Indicates the network interface name.
   * @permission ohos.permission.GET_NETWORK_INFO
   * @systemapi Hide this for inner system use.
   * @throws {BusinessError} 201 NETMANAGER_EXT_ERR_PERMISSION_DENIED
   * @throws {BusinessError} 2200105 NETMANAGER_EXT_ERR_LOCAL_PTR_NULL
   * @throws {BusinessError} 2200202 NETMANAGER_EXT_ERR_WRITE_DESCRIPTOR_TOKEN_FAIL
   * @throws {BusinessError} 2200204 NETMANAGER_EXT_ERR_WRITE_REPLY_FAIL
   * @throws {BusinessError} 2200205 NETMANAGER_EXT_ERR_READ_DATA_FAIL
   * @throws {BusinessError} 2200207 NETMANAGER_EXT_ERR_IPC_CONNECT_STUB_FAIL
   * @throws {BusinessError} 2201005 ETHERNET_ERR_DEVICE_INFORMATION_NOT_EXIST
   */
  function getIfaceConfig(iface: string, callback: AsyncCallback<InterfaceConfiguration>): void;
  function getIfaceConfig(iface: string): Promise<InterfaceConfiguration>;

  /**
   * Set the specified network interface parameters.
   *
   * @param iface Indicates the network interface name of the network parameter.
   * @param ic Indicates the ic. See {@link InterfaceConfiguration}.
   * @permission ohos.permission.CONNECTIVITY_INTERNAL
   * @systemapi Hide this for inner system use.
   * @throws {BusinessError} 201 NETMANAGER_EXT_ERR_PERMISSION_DENIED
   * @throws {BusinessError} 2200105 NETMANAGER_EXT_ERR_LOCAL_PTR_NULL
   * @throws {BusinessError} 2200202 NETMANAGER_EXT_ERR_WRITE_DESCRIPTOR_TOKEN_FAIL
   * @throws {BusinessError} 2200205 NETMANAGER_EXT_ERR_READ_DATA_FAIL
   * @throws {BusinessError} 2200207 NETMANAGER_EXT_ERR_IPC_CONNECT_STUB_FAIL
   * @throws {BusinessError} 2201004 ETHERNET_ERR_DEVICE_CONFIGURATION_INVALID
   * @throws {BusinessError} 2201005 ETHERNET_ERR_DEVICE_INFORMATION_NOT_EXIST
   * @throws {BusinessError} 2201006 ETHERNET_ERR_DEVICE_NOT_LINK
   * @throws {BusinessError} 2201007 ETHERNET_ERR_USER_CONIFGURATION_WRITE_FAIL
   */
  function setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback<void>): void;
  function setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise<void>;

  /**
   * Check whether the specified network is active.
   *
   * @param iface Indicates the network interface name.
   * @permission ohos.permission.GET_NETWORK_INFO
   * @systemapi Hide this for inner system use.
   * @throws {BusinessError} 201 NETMANAGER_EXT_ERR_PERMISSION_DENIED
   * @throws {BusinessError} 2200105 NETMANAGER_EXT_ERR_LOCAL_PTR_NULL
   * @throws {BusinessError} 2200202 NETMANAGER_EXT_ERR_WRITE_DESCRIPTOR_TOKEN_FAIL
   * @throws {BusinessError} 2200204 NETMANAGER_EXT_ERR_WRITE_REPLY_FAIL
   * @throws {BusinessError} 2200205 NETMANAGER_EXT_ERR_READ_DATA_FAIL
   * @throws {BusinessError} 2200207 NETMANAGER_EXT_ERR_IPC_CONNECT_STUB_FAIL
   * @throws {BusinessError} 2201005 ETHERNET_ERR_DEVICE_INFORMATION_NOT_EXIST
   */
  function isIfaceActive(iface?: string, callback: AsyncCallback<number>): void;
  function isIfaceActive(iface?: string): Promise<number>;

  /**
   * Gets the names of all active network interfaces.
   *
   * @permission ohos.permission.GET_NETWORK_INFO
   * @systemapi Hide this for inner system use.
   * @throws {BusinessError} 201 NETMANAGER_EXT_ERR_PERMISSION_DENIED
   * @throws {BusinessError} 2200105 NETMANAGER_EXT_ERR_LOCAL_PTR_NULL
   * @throws {BusinessError} 2200202 NETMANAGER_EXT_ERR_WRITE_DESCRIPTOR_TOKEN_FAIL
   * @throws {BusinessError} 2200204 NETMANAGER_EXT_ERR_WRITE_REPLY_FAIL
   * @throws {BusinessError} 2200205 NETMANAGER_EXT_ERR_READ_DATA_FAIL
   * @throws {BusinessError} 2200207 NETMANAGER_EXT_ERR_IPC_CONNECT_STUB_FAIL
   */
  function getAllActiveIfaces(callback: AsyncCallback<Array<string>>): void;
  function getAllActiveIfaces(): Promise<Array<string>>;

  /**
   * @systemapi Hide this for inner system use.
   */
  export interface InterfaceConfiguration {
    /*See {@link IPSetMode}*/
    mode: IPSetMode;
    ipAddr: string;
    route: string;
    gateway: string;
    netMask: string;
    dnsServers: string;
    domain: string;
  }

  /**
   * @systemapi Hide this for inner system use.
   */
  export enum IPSetMode {
    STATIC = 0,
    DHCP = 1
  }
}

export default ethernet;