NetworkInfo.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_TYPES_NETWORKINFO_H_
#define ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_TYPES_NETWORKINFO_H_

#include <istream>
#include <ostream>
#include <string>

#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace settings {
namespace types {

class NetworkInfo {
public:
    enum class ConnectionType {
        ETHERNET,
        WIFI
    };

    template <typename T>
    using Optional = avsCommon::utils::Optional<T>;

    Optional<ConnectionType> getConnectionType() const;

    Optional<std::string> getEssid() const;

    Optional<std::string> getBssid() const;

    Optional<std::string> getIpAddress() const;

    Optional<std::string> getSubnetMask() const;

    Optional<std::string> getMacAddress() const;

    Optional<std::string> getDhcpServerAddress() const;

    Optional<bool> getIsStaticIP() const;

    void setConnectionType(const ConnectionType& connectionType);

    void setEssid(const std::string& essid);

    bool setBssid(const std::string& bssid);

    bool setIpAddress(const std::string& ipAddress);

    bool setSubnetMask(const std::string& subnetMask);

    bool setMacAddress(const std::string& macAddress);

    bool setDhcpServerAddress(const std::string& dhcpServerAddress);

    void setIsStaticIP(bool isStaticIP);

    void resetConnectionType();

    void resetEssid();

    void resetBssid();

    void resetIpAddress();

    void resetSubnetMask();

    void resetMacAddress();

    void resetDhcpServerAddress();

    void resetIsStaticIP();

    bool operator==(const NetworkInfo& rhs) const;
    bool operator!=(const NetworkInfo& rhs) const;

private:
    bool validMacAddress(const std::string& input);

    bool validIpAddress(const std::string& input);

    bool validSubnetMask(const std::string& input);

    Optional<ConnectionType> m_connectionType;

    Optional<std::string> m_essid;

    Optional<std::string> m_bssid;

    Optional<std::string> m_ipAddress;

    Optional<std::string> m_subnetMask;

    Optional<std::string> m_macAddress;

    Optional<std::string> m_dhcpServerAddress;

    Optional<bool> m_isStaticIP;

    friend std::ostream& operator<<(std::ostream& os, const NetworkInfo& info);
};

std::ostream& operator<<(std::ostream& os, const NetworkInfo& info);

std::istream& operator>>(std::istream& is, NetworkInfo& info);

}  // namespace types
}  // namespace settings
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_SETTINGS_INCLUDE_SETTINGS_TYPES_NETWORKINFO_H_