//=============================================================================================================
/**
 * @file     stream_discovery.h
 * @author   Christoph Dinh <chdinh@nmr.mgh.harvard.edu>
 * @since    2.0.0
 * @date     February, 2026
 *
 * @section  LICENSE
 *
 * Copyright (C) 2026, Christoph Dinh. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 * the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * 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.
 *     * Neither the name of MNE-CPP authors 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 OWNER 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.
 *
 *
 * @brief    Contains the declaration of stream discovery functions.
 *
 */

#ifndef LSL_STREAM_DISCOVERY_H
#define LSL_STREAM_DISCOVERY_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "lsl_global.h"
#include "stream_info.h"

//=============================================================================================================
// STL INCLUDES
//=============================================================================================================

#include <vector>
#include <string>

//=============================================================================================================
// DEFINE NAMESPACE lsl
//=============================================================================================================

namespace LSLLIB {

//=============================================================================================================
/**
 * @brief Resolve all streams currently available on the network.
 *
 * Listens on the UDP multicast discovery channel for stream announcements from outlets.
 * This call blocks for the specified timeout duration while collecting results.
 *
 * @param[in] timeout   Duration (in seconds) to listen for stream announcements. Default: 1.0.
 * @return              A vector of stream_info objects for all discovered streams.
 */
LSLSHARED_EXPORT std::vector<stream_info> resolve_streams(double timeout = 1.0);

//=============================================================================================================
/**
 * @brief Resolve streams by a specific property value.
 *
 * Listens on the UDP multicast discovery channel and returns only streams whose specified
 * property matches the given value.
 *
 * @param[in] prop      The stream property to match (e.g. "name", "type", "source_id").
 * @param[in] value     The value that the property must have.
 * @param[in] timeout   Duration (in seconds) to listen for stream announcements. Default: 1.0.
 * @return              A vector of matching stream_info objects.
 */
LSLSHARED_EXPORT std::vector<stream_info> resolve_stream(const std::string& prop,
                                                         const std::string& value,
                                                         double timeout = 1.0);

} // namespace LSLLIB

#endif // LSL_STREAM_DISCOVERY_H
