common.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 sACN. For more information, go to:
 * https://github.com/ETCLabs/sACN
 *****************************************************************************/
 
#ifndef SACN_CPP_COMMON_H_
#define SACN_CPP_COMMON_H_
 
#include "etcpal/cpp/error.h"
#include "etcpal/cpp/log.h"
#include "etcpal/cpp/uuid.h"
#include "sacn/common.h"
 
namespace sacn
{
enum class McastMode
{
  kEnabledOnAllInterfaces,
  kDisabledOnAllInterfaces
};
 
using RemoteSourceHandle = sacn_remote_source_t;
constexpr RemoteSourceHandle kInvalidRemoteSourceHandle = SACN_REMOTE_SOURCE_INVALID;
 
inline etcpal::Error Init(const EtcPalLogParams* log_params = nullptr,
                          McastMode mcast_mode = McastMode::kEnabledOnAllInterfaces)
{
  SacnNetintConfig netint_config = SACN_NETINT_CONFIG_DEFAULT_INIT;
  if (mcast_mode == McastMode::kDisabledOnAllInterfaces)
    netint_config.no_netints = true;
 
  return sacn_init(log_params, &netint_config);
}
 
inline etcpal::Error Init(const EtcPalLogParams* log_params, std::vector<SacnMcastInterface>& sys_netints)
{
  SacnNetintConfig netint_config = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints = sys_netints.data();
  netint_config.num_netints = sys_netints.size();
 
  return sacn_init(log_params, &netint_config);
}
 
inline etcpal::Error Init(std::vector<SacnMcastInterface>& sys_netints)
{
  SacnNetintConfig netint_config = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints = sys_netints.data();
  netint_config.num_netints = sys_netints.size();
 
  return sacn_init(nullptr, &netint_config);
}
 
inline etcpal::Error Init(const etcpal::Logger& logger, McastMode mcast_mode = McastMode::kEnabledOnAllInterfaces)
{
  SacnNetintConfig netint_config = SACN_NETINT_CONFIG_DEFAULT_INIT;
  if (mcast_mode == McastMode::kDisabledOnAllInterfaces)
    netint_config.no_netints = true;
 
  return sacn_init(&logger.log_params(), &netint_config);
}
 
inline etcpal::Error Init(const etcpal::Logger& logger, std::vector<SacnMcastInterface>& sys_netints)
{
  SacnNetintConfig netint_config = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints = sys_netints.data();
  netint_config.num_netints = sys_netints.size();
 
  return sacn_init(&logger.log_params(), &netint_config);
}
 
inline void Deinit()
{
  return sacn_deinit();
}
 
inline RemoteSourceHandle GetRemoteSourceHandle(const etcpal::Uuid& source_cid)
{
  return sacn_get_remote_source_handle(&source_cid.get());
}
 
inline etcpal::Expected<etcpal::Uuid> GetRemoteSourceCid(RemoteSourceHandle source_handle)
{
  EtcPalUuid cid;
  etcpal_error_t error = sacn_get_remote_source_cid(source_handle, &cid);
  etcpal::Uuid cid_to_return = cid;
 
  if (error == kEtcPalErrOk)
    return cid_to_return;
 
  return error;
}
 
};  // namespace sacn
 
#endif  // SACN_CPP_COMMON_H_