src/core/config/joiner.h

/*
 *  Copyright (c) 2019, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 *   This file includes compile-time configurations for the Joiner.
 */

#ifndef OT_CORE_CONFIG_JOINER_H_
#define OT_CORE_CONFIG_JOINER_H_

/**
 * @addtogroup config-joiner
 *
 * @brief
 *   This module includes configuration variables for the Joiner.
 *
 * @{
 */

/**
 * @def OPENTHREAD_CONFIG_JOINER_ENABLE
 *
 * Define to 1 to enable Joiner support.
 */
#ifndef OPENTHREAD_CONFIG_JOINER_ENABLE
#define OPENTHREAD_CONFIG_JOINER_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES
 *
 * The maximum number of Joiner Router candidates that can be tracked by the Joiner/Seeker.
 */
#ifndef OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES
#define OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES 16
#endif

/**
 * @def OPENTHREAD_CONFIG_JOINER_CANDIDATES_PER_NETWORK
 *
 * The maximum number of Joiner Router candidates to track per network (Extended PAN ID) by the Joiner/Seeker.
 */
#ifndef OPENTHREAD_CONFIG_JOINER_CANDIDATES_PER_NETWORK
#define OPENTHREAD_CONFIG_JOINER_CANDIDATES_PER_NETWORK 3
#endif

/**
 * @def OPENTHREAD_CONFIG_JOINER_ADV_EXPERIMENTAL_ENABLE
 *
 * Define as 1 to enable including Joiner Advertisement TLV during discovery scan by the Joiner.
 *
 * This is an experimental feature. It is not part of the Thread specification. See `otThreadSetJoinerAdvertisement`
 * for more details.
 */
#ifndef OPENTHREAD_CONFIG_JOINER_ADV_EXPERIMENTAL_ENABLE
#define OPENTHREAD_CONFIG_JOINER_ADV_EXPERIMENTAL_ENABLE 0
#endif

/**
 * @def OPENTHREAD_CONFIG_SEEKER_ENABLE
 *
 * Define as 1 to enable Seeker functionality and `otSeeker` APIs.
 *
 * The Seeker is a part of the Thread MeshCoP process. It is responsible for discovering nearby Joiner Router
 * candidates, prioritizing them, and iterating through the list to select the best candidate for connection.
 * It also operates as a sub-system of the `Joiner`, delegating control to the next layer to enable the
 * implementation of alternative and custom joining protocols.
 */
#ifndef OPENTHREAD_CONFIG_SEEKER_ENABLE
#define OPENTHREAD_CONFIG_SEEKER_ENABLE OPENTHREAD_CONFIG_JOINER_ENABLE
#endif

/**
 * @}
 */

#endif // OT_CORE_CONFIG_JOINER_H_