1 /**
2 * Copyright The Apache Software Foundation
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21 package org.apache.hadoop.hbase.client;
22
23 import org.apache.hadoop.hbase.protobuf.generated.MasterAdminProtos;
24
25 /**
26 * A KeepAlive connection is not physically closed immediately after the close,
27 * but rather kept alive for a few minutes. It makes sense only if it is shared.
28 *
29 * <p>This interface is implemented on a stub. It allows to have a #close function in a master
30 * client.
31 *
32 * <p>This class is intended to be used internally by HBase classes that need to make invocations
33 * against the master on the MasterAdminProtos.MasterAdminService.BlockingInterface; but not by
34 * final user code. Hence it's package protected.
35 */
36 interface MasterAdminKeepAliveConnection
37 extends MasterAdminProtos.MasterAdminService.BlockingInterface {
38 /**
39 * Close down all resources.
40 */
41 // The Closeable Interface wants to throw an IOE out of a close.
42 // Thats a PITA. Do this below instead of Closeable.
43 void close();
44 }