/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching.Providers.VNCache
* File: IClusterNodeIndex.cs
*
* IClusterNodeIndex.cs is part of VNLib.Data.Caching.Providers.VNCache which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching.Providers.VNCache is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Data.Caching.Providers.VNCache is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System.Threading;
using System.Threading.Tasks;
using VNLib.Data.Caching.Extensions.Clustering;
namespace VNLib.Data.Caching.Providers.VNCache.Clustering
{
internal interface IClusterNodeIndex
{
///
/// Gets the next available node using the configured balancing policy
/// or null if no nodes are available
///
/// The next available node to connect to if any are available
CacheNodeAdvertisment? GetNextNode();
///
/// Waits for the discovery process to complete. This is just incase a
/// connection wants to happen while a long discovery is processing.
///
/// A token to cancel the operation
/// A task that resolves when the discovery process completes
Task WaitForDiscoveryAsync(CancellationToken cancellationToken);
}
}