source_detector.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_SOURCE_DETECTOR_H_
#define SACN_SOURCE_DETECTOR_H_
 
#include <stdbool.h>
#include <stdint.h>
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "etcpal/log.h"
#include "etcpal/netint.h"
#include "etcpal/uuid.h"
#include "sacn/common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum
{
  kSacnSourceDetectorInfinite = 0
};
 
typedef void (*SacnSourceDetectorSourceUpdatedCallback)(sacn_remote_source_t handle,
                                                        const EtcPalUuid*    cid,
                                                        const char*          name,
                                                        const uint16_t*      sourced_universes,
                                                        size_t               num_sourced_universes,
                                                        void*                context);
 
typedef void (*SacnSourceDetectorSourceExpiredCallback)(sacn_remote_source_t handle,
                                                        const EtcPalUuid*    cid,
                                                        const char*          name,
                                                        void*                context);
 
typedef void (*SacnSourceDetectorLimitExceededCallback)(void* context);
 
typedef struct SacnSourceDetectorCallbacks
{
  SacnSourceDetectorSourceUpdatedCallback source_updated; 
  SacnSourceDetectorSourceExpiredCallback source_expired; 
  SacnSourceDetectorLimitExceededCallback limit_exceeded; 
  void* context; 
} SacnSourceDetectorCallbacks;
 
typedef struct SacnSourceDetectorConfig
{
  SacnSourceDetectorCallbacks callbacks;
 
  /********* Optional values **********/
 
  int source_count_max;
 
  int universes_per_source_max;
 
  sacn_ip_support_t ip_supported;
} SacnSourceDetectorConfig;
 
#define SACN_SOURCE_DETECTOR_CONFIG_DEFAULT_INIT \
  {{NULL, NULL, NULL, NULL}, kSacnSourceDetectorInfinite, kSacnSourceDetectorInfinite, kSacnIpV4AndIpV6}
 
void sacn_source_detector_config_init(SacnSourceDetectorConfig* config);
 
etcpal_error_t sacn_source_detector_create(const SacnSourceDetectorConfig* config,
                                           const SacnNetintConfig*         netint_config);
void           sacn_source_detector_destroy();
 
etcpal_error_t sacn_source_detector_reset_networking(const SacnNetintConfig* sys_netint_config);
 
size_t sacn_source_detector_get_network_interfaces(EtcPalMcastNetintId* netints, size_t netints_size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SACN_SOURCE_DETECTOR_H_ */