View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.ipc;
20  
21  import java.io.IOException;
22  import java.net.InetSocketAddress;
23  
24  import javax.net.SocketFactory;
25  
26  import org.apache.hadoop.classification.InterfaceAudience;
27  import org.apache.hadoop.conf.Configuration;
28  import org.apache.hadoop.hbase.security.User;
29  
30  /** An RPC implementation. */
31  @InterfaceAudience.Private
32  interface RpcEngine {
33  
34    /** Construct a client-side proxy object. */
35    VersionedProtocol getProxy(Class<? extends VersionedProtocol> protocol,
36                    long clientVersion, InetSocketAddress addr,
37                    User ticket, Configuration conf,
38                    SocketFactory factory, int rpcTimeout) throws IOException;
39  
40    /** Stop this proxy. */
41    void stopProxy(VersionedProtocol proxy);
42  
43    /** Construct a server for a protocol implementation instance. */
44    RpcServer getServer(Class<? extends VersionedProtocol> protocol, Object instance,
45                         Class<?>[] ifaces, String bindAddress,
46                         int port, int numHandlers, int metaHandlerCount,
47                         boolean verbose, Configuration conf, int highPriorityLevel)
48        throws IOException;
49  }