001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos;
023
024/**
025 * A KeepAlive connection is not physically closed immediately after the close, but rather kept
026 * alive for a few minutes. It makes sense only if it is shared.
027 * <p>
028 * This interface is implemented on a stub. It allows to have a #close function in a master client.
029 * <p>
030 * This class is intended to be used internally by HBase classes that need to make invocations
031 * against the master on the MasterProtos.MasterService.BlockingInterface; but not by final user
032 * code. Hence it's package protected.
033 */
034@InterfaceAudience.Private
035interface MasterKeepAliveConnection extends MasterProtos.MasterService.BlockingInterface {
036  // Do this instead of implement Closeable because closeable returning IOE is PITA.
037  void close();
038}