View Javadoc

1   /*
2    * Copyright 2010 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  package org.apache.hadoop.hbase.ipc;
21  
22  import java.lang.reflect.Method;
23  import java.io.IOException;
24  import java.net.InetSocketAddress;
25  
26  import org.apache.hadoop.classification.InterfaceAudience;
27  import org.apache.hadoop.conf.Configurable;
28  import org.apache.hadoop.hbase.security.User;
29  import org.apache.hadoop.conf.Configuration;
30  
31  /** An RPC implementation. */
32  @InterfaceAudience.Private
33  public interface RpcEngine extends Configurable {
34  
35    /* Client-related methods */
36    /** Construct a client-side proxy object. */
37    <T extends VersionedProtocol> T getProxy(Class<T> protocol,
38                                             long clientVersion, InetSocketAddress addr,
39                                             Configuration conf, int rpcTimeout) throws IOException;
40  
41    /** Shutdown this instance */
42    void close();
43  
44    /** Expert: Make multiple, parallel calls to a set of servers. */
45    Object[] call(Method method, Object[][] params, InetSocketAddress[] addrs,
46                  Class<? extends VersionedProtocol> protocol,
47                  User ticket, Configuration conf)
48      throws IOException, InterruptedException;
49  
50    /* Server-related methods */
51    /** Construct a server for a protocol implementation instance. */
52    RpcServer getServer(Class<? extends VersionedProtocol> protocol, Object instance,
53                         Class<?>[] ifaces, String bindAddress,
54                         int port, int numHandlers, int metaHandlerCount,
55                         boolean verbose, Configuration conf, int highPriorityLevel)
56        throws IOException;
57  
58  }