/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */
package org.apache.phoenix.log;

import java.sql.SQLException;
import org.apache.phoenix.jdbc.PhoenixConnection;

/**
 * This interface defines the contract for storing information about Phoenix connections for
 * debugging client-side issues like
 * {@link org.apache.phoenix.exception.SQLExceptionCode#NEW_CONNECTION_THROTTLED}
 */
public interface ConnectionLimiter {

  void acquireConnection(PhoenixConnection connection) throws SQLException;

  void returnConnection(PhoenixConnection connection);

  int onSweep(boolean internal);

  boolean isLastConnection();

  boolean isShouldThrottleNumConnections();

  int getConnectionCount();

  int getInternalConnectionCount();
}
