/*
 *  Copyright (c) 2020, 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 definitions for Multicast Listener Registration states of multicast addresses.
 */

#ifndef OT_CORE_THREAD_MLR_TYPES_HPP_
#define OT_CORE_THREAD_MLR_TYPES_HPP_

#include "openthread-core-config.h"

#include "common/array.hpp"
#include "common/error.hpp"
#include "net/ip6_address.hpp"

namespace ot {
namespace Mlr {

/**
 * @addtogroup core-mlr
 *
 * @{
 */

constexpr uint8_t kMinIp6Addresses = 1;                        ///< Min number of addresses in IPv6 Addresses TLV.
constexpr uint8_t kMaxIp6Addresses = OT_IP6_MAX_MLR_ADDRESSES; ///< Max number of addresses in IPv6 Addresses TLV.

/**
 * Multicast Listener Registration (MLR) Status values.
 */
enum Status : uint8_t
{
    kStatusSuccess        = 0, ///< Successful (de)registration of all IPv6 addresses.
    kStatusInvalid        = 2, ///< Invalid IPv6 address(es) in request.
    kStatusNoPersistent   = 3, ///< This device does not support persistent registrations.
    kStatusNoResources    = 4, ///< BBR resource shortage.
    kStatusBbrNotPrimary  = 5, ///< BBR is not Primary at this moment.
    kStatusGeneralFailure = 6, ///< Reason(s) for failure are not further specified.
};

constexpr uint8_t kMaxStatusValue = kStatusGeneralFailure;

/**
 * Represents an array of IPv6 addresses.
 */
class AddressArray : public Array<Ip6::Address, kMaxIp6Addresses>
{
public:
    /**
     * Adds an IPv6 address to the array if it is not already present.
     *
     * @param[in] aAddress  The IPv6 address to add.
     *
     * @retval kErrorNone    Successfully added the address or it was already present.
     * @retval kErrorNoBufs  The array is full.
     */
    Error AddUnique(const Ip6::Address &aAddress);
};

} // namespace Mlr
} // namespace ot

#endif // OT_CORE_THREAD_MLR_TYPES_HPP_
