View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.regionserver;
19  
20  import org.apache.hadoop.conf.Configuration;
21  import org.apache.hadoop.hbase.ipc.RpcScheduler;
22  
23  /**
24   * A factory class that constructs an {@link org.apache.hadoop.hbase.ipc.RpcScheduler} for
25   * a region server.
26   */
27  public interface RpcSchedulerFactory {
28  
29    /**
30     * Constructs a {@link org.apache.hadoop.hbase.ipc.RpcScheduler}.
31     *
32     * Please note that this method is called in constructor of {@link HRegionServer}, so some
33     * fields may not be ready for access. The reason that {@code HRegionServer} is passed as
34     * parameter here is that an RPC scheduler may need to access data structure inside
35     * {@code HRegionServer} (see example in {@link SimpleRpcSchedulerFactory}).
36     */
37    RpcScheduler create(Configuration conf, RegionServerServices server);
38  }