opts.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 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 RDMnet. For more information, go to:
 * https://github.com/ETCLabs/RDMnet
 *****************************************************************************/
 
#ifndef RDMNET_CORE_OPTS_H_
#define RDMNET_CORE_OPTS_H_
 
#if RDMNET_HAVE_CONFIG_H
#include "rdmnet_config.h"
#endif
 
#include "etcpal/thread.h"
 
/* Some option hints based on well-known compile definitions */
 
/* Are we being compiled for a full-featured OS? */
#if defined(_WIN32) || defined(__APPLE__) || defined(__linux__) || defined(__unix__) || defined(_POSIX_VERSION)
#define RDMNET_FULL_OS_AVAILABLE_HINT 1
#else
#define RDMNET_FULL_OS_AVAILABLE_HINT 0
#endif
 
/* Are we being compiled in/for a Microsoft Windows environment? */
#ifdef _WIN32
#define RDMNET_WINDOWS_HINT 1
#else
#define RDMNET_WINDOWS_HINT 0
#endif
 
/********************************* Global ************************************/
 
#ifndef RDMNET_DYNAMIC_MEM
#define RDMNET_DYNAMIC_MEM RDMNET_FULL_OS_AVAILABLE_HINT
#endif
 
#ifndef RDMNET_LOG_MSG_PREFIX
#define RDMNET_LOG_MSG_PREFIX "RDMnet: "
#endif
 
#ifndef RDMNET_ASSERT
#include <assert.h>
#define RDMNET_ASSERT(expr) assert(expr)
#endif
 
#ifndef RDMNET_MAX_CONTROLLERS
#define RDMNET_MAX_CONTROLLERS 0
#endif
 
#ifndef RDMNET_MAX_DEVICES
#define RDMNET_MAX_DEVICES 1
#endif
 
#ifndef RDMNET_MAX_EPT_CLIENTS
#define RDMNET_MAX_EPT_CLIENTS 0
#endif
 
#ifndef RDMNET_MAX_SCOPES_PER_CONTROLLER
#define RDMNET_MAX_SCOPES_PER_CONTROLLER 1
#endif
 
#ifndef RDMNET_MAX_ENDPOINTS_PER_DEVICE
#define RDMNET_MAX_ENDPOINTS_PER_DEVICE 1
#endif
 
#ifndef RDMNET_MAX_RESPONDERS_PER_DEVICE_ENDPOINT
#define RDMNET_MAX_RESPONDERS_PER_DEVICE_ENDPOINT 1
#endif
 
#ifndef RDMNET_MAX_PROTOCOLS_PER_EPT_CLIENT
#define RDMNET_MAX_PROTOCOLS_PER_EPT_CLIENT 5
#endif
 
#ifndef RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES
#define RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES 2
#endif
 
#ifdef RDMNET_MAX_RPT_CLIENTS
#undef RDMNET_MAX_RPT_CLIENTS
#endif
#define RDMNET_MAX_RPT_CLIENTS (RDMNET_MAX_CONTROLLERS + RDMNET_MAX_DEVICES)
 
#ifdef RDMNET_MAX_CLIENTS
#undef RDMNET_MAX_CLIENTS
#endif
#define RDMNET_MAX_CLIENTS (RDMNET_MAX_RPT_CLIENTS + RDMNET_MAX_EPT_CLIENTS)
 
#if !RDMNET_MAX_CLIENTS
#undef RDMNET_MAX_CLIENTS
#define RDMNET_MAX_CLIENTS 1
#endif
 
#if RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES < 1
#undef RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES
#define RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES 1
#endif
 
#ifndef RDMNET_MAX_CONNECTIONS
#define RDMNET_MAX_CONNECTIONS RDMNET_MAX_CLIENTS
#endif
 
#if RDMNET_MAX_CONNECTIONS < 1
#undef RDMNET_MAX_CONNECTIONS
#define RDMNET_MAX_CONNECTIONS 1
#endif
 
#ifndef RDMNET_PARSER_MAX_CLIENT_ENTRIES
#define RDMNET_PARSER_MAX_CLIENT_ENTRIES 5
#endif
 
#if RDMNET_PARSER_MAX_CLIENT_ENTRIES < 1
#undef RDMNET_PARSER_MAX_CLIENT_ENTRIES
#define RDMNET_PARSER_MAX_CLIENT_ENTRIES 1
#endif
 
#ifndef RDMNET_PARSER_MAX_EPT_SUBPROTS
#define RDMNET_PARSER_MAX_EPT_SUBPROTS 5
#endif
 
#if RDMNET_PARSER_MAX_EPT_SUBPROTS < 1
#undef RDMNET_PARSER_MAX_EPT_SUBPROTS
#define RDMNET_PARSER_MAX_EPT_SUBPROTS 1
#endif
 
#ifndef RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES
#define RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES 5
#endif
 
#if RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES < 1
#undef RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES
#define RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES 1
#endif
 
#ifndef RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES
#define RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES 5
#endif
 
#if RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES < 1
#undef RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES
#define RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES 1
#endif
 
#ifndef RDMNET_MAX_MCAST_NETINTS
#define RDMNET_MAX_MCAST_NETINTS 3
#endif
 
#if RDMNET_MAX_MCAST_NETINTS < 1
#undef RDMNET_MAX_MCAST_NETINTS
#define RDMNET_MAX_MCAST_NETINTS 1
#endif
 
#ifndef RDMNET_BIND_MCAST_SOCKETS_TO_MCAST_ADDRESS
#define RDMNET_BIND_MCAST_SOCKETS_TO_MCAST_ADDRESS !RDMNET_WINDOWS_HINT
#endif
 
#ifndef RDMNET_TICK_THREAD_PRIORITY
#define RDMNET_TICK_THREAD_PRIORITY ETCPAL_THREAD_DEFAULT_PRIORITY
#endif
 
#ifndef RDMNET_TICK_THREAD_STACK
#define RDMNET_TICK_THREAD_STACK (ETCPAL_THREAD_DEFAULT_STACK * 2)
#endif
 
#ifndef RDMNET_MAX_MONITORED_SCOPES
#define RDMNET_MAX_MONITORED_SCOPES ((RDMNET_MAX_SCOPES_PER_CONTROLLER * RDMNET_MAX_CONTROLLERS) + RDMNET_MAX_DEVICES)
#endif
 
#ifndef RDMNET_MAX_DISCOVERED_BROKERS_PER_SCOPE
#define RDMNET_MAX_DISCOVERED_BROKERS_PER_SCOPE 1
#endif
 
#ifndef RDMNET_MAX_ADDRS_PER_DISCOVERED_BROKER
#define RDMNET_MAX_ADDRS_PER_DISCOVERED_BROKER 2
#endif
 
#if !RDMNET_MAX_ADDRS_PER_DISCOVERED_BROKER
#error "RDMNET_MAX_ADDRS_PER_DISCOVERED_BROKER must be at least 1"
#endif
 
#ifndef RDMNET_MAX_ADDITIONAL_TXT_ITEMS_PER_DISCOVERED_BROKER
#define RDMNET_MAX_ADDITIONAL_TXT_ITEMS_PER_DISCOVERED_BROKER 5
#endif
 
#if RDMNET_MAX_ADDITIONAL_TXT_ITEMS_PER_DISCOVERED_BROKER < 1
#undef RDMNET_MAX_ADDITIONAL_TXT_ITEMS_PER_DISCOVERED_BROKER
#define RDMNET_MAX_ADDITIONAL_TXT_ITEMS_PER_DISCOVERED_BROKER 1
#endif
 
#ifndef RDMNET_MAX_LLRP_TARGETS
#define RDMNET_MAX_LLRP_TARGETS RDMNET_MAX_CLIENTS
#endif
 
#if RDMNET_MAX_LLRP_TARGETS
#define RC_MAX_LLRP_TARGETS RDMNET_MAX_LLRP_TARGETS
#else
#define RC_MAX_LLRP_TARGETS 1
#endif
 
#endif /* RDMNET_CORE_OPTS_H_ */