src/connectivity/network/lib/net_interfaces/cpp/net_interfaces.h

// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_CONNECTIVITY_NETWORK_LIB_NET_INTERFACES_CPP_NET_INTERFACES_H_
#define SRC_CONNECTIVITY_NETWORK_LIB_NET_INTERFACES_CPP_NET_INTERFACES_H_

#include <fuchsia/net/interfaces/cpp/fidl.h>

#include <optional>

namespace net::interfaces {
// Move-only wrapper for fuchsia::net::interface::Properties that guarantees
// that its inner |properties_| are valid and complete properties as reported by
// |VerifyCompleteProperties|.
class Properties final {
 public:
  // Creates an |Properties| if |properties| are valid complete
  // properties as reported by |VerifyCompleteProperties|.
  static std::optional<Properties> VerifyAndCreate(fuchsia::net::interfaces::Properties properties);
  Properties(Properties&& interface) noexcept;
  Properties& operator=(Properties&& interface) noexcept;
  ~Properties();

  // Updates this instance with the values set in |properties|. Fields not set in |properties|
  // retain their previous values. Returns false if the |properties| has a missing or mismatched
  // |id| field, or if any field set in |properties| has an invalid value (e.g. an address that does
  // not actually contain an address).
  //
  // |properties| will be modified such that it contains the previous values of all mutable fields
  // which changed upon return. This is useful when a user needs to know precisely how the addresses
  // field has changed as a result of the update. Note that in particular, the |id| field is
  // immutable and thus will not be present in |properties| upon return.
  bool Update(fuchsia::net::interfaces::Properties* properties);

  uint64_t id() const { return properties_.id(); }
  const ::std::string& name() const { return properties_.name(); }
  const fuchsia::net::interfaces::DeviceClass& device_class() const {
    return properties_.device_class();
  }
  bool is_loopback() const {
    return device_class().Which() == fuchsia::net::interfaces::DeviceClass::kLoopback;
  }
  bool online() const { return properties_.online(); }
  bool has_default_ipv4_route() const { return properties_.has_default_ipv4_route(); }
  bool has_default_ipv6_route() const { return properties_.has_default_ipv6_route(); }
  const ::std::vector<fuchsia::net::interfaces::Address>& addresses() const {
    return properties_.addresses();
  }

 private:
  explicit Properties(fuchsia::net::interfaces::Properties properties);

  fuchsia::net::interfaces::Properties properties_;
};

}  // namespace net::interfaces

#endif  // SRC_CONNECTIVITY_NETWORK_LIB_NET_INTERFACES_CPP_NET_INTERFACES_H_