netint.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2024 ETC Inc.
 *
 * 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.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
 
#ifndef ETCPAL_CPP_NETINT_H_
#define ETCPAL_CPP_NETINT_H_
 
#include <algorithm>
#include <vector>
#include "etcpal/netint.h"
#include "etcpal/cpp/common.h"
#include "etcpal/cpp/error.h"
#include "etcpal/cpp/inet.h"
 
namespace etcpal
{
 
 
namespace netint
{
 
namespace detail
{
inline etcpal::Expected<std::vector<etcpal::NetintInfo>> GetInterfaces(NetintIndex index = NetintIndex()) noexcept
{
  static constexpr size_t kInitialEstimatedCount = 4u;
 
  int resize_count = 0;
 
  size_t                        num_netints = kInitialEstimatedCount;  // Start with estimate
  std::vector<EtcPalNetintInfo> c_netints(num_netints);
  auto                          err = kEtcPalErrOk;
  while ((err = (index.IsValid() ? etcpal_netint_get_interfaces_for_index(index.value(), c_netints.data(), &num_netints)
                                 : etcpal_netint_get_interfaces(c_netints.data(), &num_netints))) == kEtcPalErrBufSize)
  {
    if (resize_count > 10)
      return kEtcPalErrBufSize;  // Something screwy is going on, so avoid a potentially infinite loop
 
    c_netints.resize(num_netints);
    ++resize_count;
  }
 
  if (err == kEtcPalErrOk)
  {
    std::vector<etcpal::NetintInfo> netints(num_netints);
    for (size_t i = 0u; i < num_netints; ++i)
      netints[i] = etcpal::NetintInfo(c_netints[i]);
 
    return netints;
  }
 
  return err;
}
}  // namespace detail
 
 
 
inline etcpal::Expected<std::vector<etcpal::NetintInfo>> GetInterfaces() noexcept
{
  return detail::GetInterfaces();
}
 
inline etcpal::Expected<std::vector<etcpal::NetintInfo>> GetInterfacesForIndex(NetintIndex index) noexcept
{
  if (!index)
    return kEtcPalErrInvalid;
 
  return detail::GetInterfaces(index);
}
 
inline etcpal::Expected<etcpal::NetintInfo> GetInterfaceWithIp(const IpAddr& ip) noexcept
{
  if (!ip.IsValid())
    return kEtcPalErrInvalid;
 
  EtcPalNetintInfo c_netint{};
  auto             err = etcpal_netint_get_interface_with_ip(&ip.get(), &c_netint);
 
  if (err == kEtcPalErrOk)
    return etcpal::NetintInfo(c_netint);
 
  return err;
}
 
inline etcpal::Expected<NetintIndex> GetDefaultInterface(etcpal::IpAddrType type) noexcept
{
  unsigned int index = 0u;
  auto         err   = etcpal_netint_get_default_interface(static_cast<etcpal_iptype_t>(type), &index);
 
  if (err == kEtcPalErrOk)
    return NetintIndex(index);
 
  return err;
}
 
inline etcpal::Expected<NetintIndex> GetInterfaceForDest(const etcpal::IpAddr& dest) noexcept
{
  unsigned int index = 0u;
  auto         err   = etcpal_netint_get_interface_for_dest(&dest.get(), &index);
 
  if (err == kEtcPalErrOk)
    return NetintIndex(index);
 
  return err;
}
 
inline etcpal::Error RefreshInterfaces() noexcept
{
  return etcpal_netint_refresh_interfaces();
}
 
inline bool IsUp(NetintIndex index) noexcept
{
  return etcpal_netint_is_up(index.value());
}
 
}  // namespace netint
 
 
}  // namespace etcpal
 
#endif  // ETCPAL_CPP_NETINT_H_