/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
*  Licensed to Elasticsearch B.V. under one or more contributor
*  license agreements. See the NOTICE file distributed with
*  this work for additional information regarding copyright
*  ownership. Elasticsearch B.V. licenses this file to you 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.
*/

using System;
using System.Collections.Generic;

namespace OpenSearch.Net
{
	public interface IConnectionPool : IDisposable
	{
		/// <summary>
		/// The last time that this instance was updated
		/// </summary>
		DateTime LastUpdate { get; }

		/// <summary>
		/// Returns the default maximum retries for the connection pool implementation.
		/// Most implementation default to number of nodes, note that this can be overidden
		/// in the connection settings
		/// </summary>
		int MaxRetries { get; }

		/// <summary>
		/// Returns a read only view of all the nodes in the cluster, which might involve creating copies of nodes e.g
		/// if you are using <see cref="SniffingConnectionPool" />.
		/// If you do not need an isolated copy of the nodes, please read <see cref="CreateView" /> to completion
		/// </summary>
		IReadOnlyCollection<Node> Nodes { get; }

		/// <summary>
		/// Whether a sniff is seen on startup. The implementation is
		/// responsible for setting this in a thread safe fashion.
		/// </summary>
		bool SniffedOnStartup { get; set; }

		/// <summary>
		/// Whether pinging is supported
		/// </summary>
		bool SupportsPinging { get; }

		/// <summary>
		/// Whether reseeding with new nodes is supported
		/// </summary>
		bool SupportsReseeding { get; }

		/// <summary>
		/// Whether SSL/TLS is being used
		/// </summary>
		bool UsingSsl { get; }

		/// <summary>
		/// Creates a view over the nodes, with changing starting positions, that wraps over on each call
		/// e.g Thread A might get 1,2,3,4,5 and thread B will get 2,3,4,5,1.
		/// if there are no live nodes yields a different dead node to try once
		/// </summary>
		IEnumerable<Node> CreateView(Action<AuditEvent, Node> audit = null);

		/// <summary>
		/// Reseeds the nodes. The implementation is responsible for thread safety
		/// </summary>
		void Reseed(IEnumerable<Node> nodes);
	}
}