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