/*
 * Copyright (C) 2021 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.
 */

#ifndef OHOS_DHCP_SERVER_SERVICE_INTERFACE_H
#define OHOS_DHCP_SERVER_SERVICE_INTERFACE_H

#include "i_dhcp_result_notify.h"
#include "dhcp_define.h"


namespace OHOS {
namespace Wifi {
class IDhcpServerService {
public:
    /**
     * @Description : Construct a new dhcp server base service object.
     *
     */
    IDhcpServerService()
    {
    }

    /**
     * @Description : Destroy the dhcp server base service object.
     *
     */
    virtual ~IDhcpServerService()
    {
    }

    /**
     * @Description : Start dhcp server service of specified interface.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int StartDhcpServer(const std::string& ifname) = 0;

    /**
     * @Description : Stop dhcp server service of specified interface.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int StopDhcpServer(const std::string& ifname) = 0;

    /**
     * @Description : Get dhcp server service running status.
     *
     * @Return : 0 - not start, 1 - normal started.
     */
    virtual int GetServerStatus(void) = 0;

    /**
     * @Description : Add or update dhcp ip address pool.
     *
     * @param tagName - ip address pool tag name [in]
     * @param range - ip address range [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int PutDhcpRange(const std::string& tagName, const DhcpRange& range) = 0;

    /**
     * @Description : Remove dhcp ip address pool.
     *
     * @param tagName - ip address pool tag name [in]
     * @param range - ip address range [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int RemoveDhcpRange(const std::string& tagName, const DhcpRange& range) = 0;

    /**
     * @Description : Remove all dhcp ip address pool.
     *
     * @param tagName - ip address pool tag name [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int RemoveAllDhcpRange(const std::string& tagName) = 0;

    /**
     * @Description : Set dhcp ip address range of specified interface.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @param range - ip address range [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int SetDhcpRange(const std::string& ifname, const DhcpRange& range) = 0;

    /**
     * @Description : Set dhcp ip address pool of specified interface.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @param tagName - ip address pool tag name [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int SetDhcpRange(const std::string& ifname, const std::string& tagName) = 0;

    /**
     * @Description : Get dhcp server lease info.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @param leases - lease info [out]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int GetLeases(const std::string& ifname, std::vector<std::string>& leases) = 0;

    /**
     * @Description : Obtain the abnormal exit status of dhcp server process.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @param pResultNotify - pointer to dhcp result notify [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int GetDhcpSerProExit(const std::string& ifname, IDhcpResultNotify *pResultNotify) = 0;

    /**
     * @Description : Reload dhcp server config.
     *
     * @param ifname - interface name, eg:wlan0 [in]
     * @Return : success - DHCP_OPT_SUCCESS, failed - others.
     */
    virtual int ReloadConfig(const std::string& ifname) = 0;
};
}  // namespace Wifi
}  // namespace OHOS
#endif