| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.ipc, class: NettyRpcClientConfigHelper"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.ipc;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.util.HashMap;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.io.netty.channel.Channel;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.io.netty.channel.EventLoopGroup;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.io.netty.channel.nio.NioEventLoopGroup;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.io.netty.channel.socket.nio.NioSocketChannel;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.io.netty.util.concurrent.DefaultThreadFactory;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Helper class for passing config to {@link NettyRpcClient}.</span> |
| <span class="source-line-no">036</span><span id="line-36"> * <p></span> |
| <span class="source-line-no">037</span><span id="line-37"> * As hadoop Configuration can not pass an Object directly, we need to find a way to pass the</span> |
| <span class="source-line-no">038</span><span id="line-38"> * EventLoopGroup to {@code AsyncRpcClient} if we want to use a single {@code EventLoopGroup} for</span> |
| <span class="source-line-no">039</span><span id="line-39"> * the whole process.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * @since 2.0.0</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.Public</span> |
| <span class="source-line-no">043</span><span id="line-43">public final class NettyRpcClientConfigHelper {</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> public static final String EVENT_LOOP_CONFIG = "hbase.rpc.client.event-loop.config";</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Name of property to change netty rpc client eventloop thread count. Default is 0. Tests may set</span> |
| <span class="source-line-no">049</span><span id="line-49"> * this down from unlimited.</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final String HBASE_NETTY_EVENTLOOP_RPCCLIENT_THREADCOUNT_KEY =</span> |
| <span class="source-line-no">052</span><span id="line-52"> "hbase.netty.eventloop.rpcclient.thread.count";</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> private static final String CONFIG_NAME = "global-event-loop";</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> private static final Map<String,</span> |
| <span class="source-line-no">057</span><span id="line-57"> Pair<EventLoopGroup, Class<? extends Channel>>> EVENT_LOOP_CONFIG_MAP = new HashMap<>();</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Shutdown constructor.</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> private NettyRpcClientConfigHelper() {</span> |
| <span class="source-line-no">063</span><span id="line-63"> }</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Set the EventLoopGroup and channel class for {@code AsyncRpcClient}.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> public static void setEventLoopConfig(Configuration conf, EventLoopGroup group,</span> |
| <span class="source-line-no">069</span><span id="line-69"> Class<? extends Channel> channelClass) {</span> |
| <span class="source-line-no">070</span><span id="line-70"> Preconditions.checkNotNull(group, "group is null");</span> |
| <span class="source-line-no">071</span><span id="line-71"> Preconditions.checkNotNull(channelClass, "channel class is null");</span> |
| <span class="source-line-no">072</span><span id="line-72"> conf.set(EVENT_LOOP_CONFIG, CONFIG_NAME);</span> |
| <span class="source-line-no">073</span><span id="line-73"> EVENT_LOOP_CONFIG_MAP.put(CONFIG_NAME,</span> |
| <span class="source-line-no">074</span><span id="line-74"> Pair.<EventLoopGroup, Class<? extends Channel>> newPair(group, channelClass));</span> |
| <span class="source-line-no">075</span><span id="line-75"> }</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * The {@link NettyRpcClient} will create its own {@code NioEventLoopGroup}.</span> |
| <span class="source-line-no">079</span><span id="line-79"> */</span> |
| <span class="source-line-no">080</span><span id="line-80"> public static void createEventLoopPerClient(Configuration conf) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> conf.set(EVENT_LOOP_CONFIG, "");</span> |
| <span class="source-line-no">082</span><span id="line-82"> EVENT_LOOP_CONFIG_MAP.clear();</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> private static volatile Pair<EventLoopGroup, Class<? extends Channel>> DEFAULT_EVENT_LOOP;</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> private static Pair<EventLoopGroup, Class<? extends Channel>></span> |
| <span class="source-line-no">088</span><span id="line-88"> getDefaultEventLoopConfig(Configuration conf) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> Pair<EventLoopGroup, Class<? extends Channel>> eventLoop = DEFAULT_EVENT_LOOP;</span> |
| <span class="source-line-no">090</span><span id="line-90"> if (eventLoop != null) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> return eventLoop;</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"> synchronized (NettyRpcClientConfigHelper.class) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> eventLoop = DEFAULT_EVENT_LOOP;</span> |
| <span class="source-line-no">095</span><span id="line-95"> if (eventLoop != null) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> return eventLoop;</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"> int threadCount = conf.getInt(HBASE_NETTY_EVENTLOOP_RPCCLIENT_THREADCOUNT_KEY, 0);</span> |
| <span class="source-line-no">099</span><span id="line-99"> eventLoop = new Pair<>(</span> |
| <span class="source-line-no">100</span><span id="line-100"> new NioEventLoopGroup(threadCount,</span> |
| <span class="source-line-no">101</span><span id="line-101"> new DefaultThreadFactory("RPCClient-NioEventLoopGroup", true, Thread.NORM_PRIORITY)),</span> |
| <span class="source-line-no">102</span><span id="line-102"> NioSocketChannel.class);</span> |
| <span class="source-line-no">103</span><span id="line-103"> DEFAULT_EVENT_LOOP = eventLoop;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"> return eventLoop;</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> static Pair<EventLoopGroup, Class<? extends Channel>> getEventLoopConfig(Configuration conf) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> String name = conf.get(EVENT_LOOP_CONFIG);</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (name == null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> return getDefaultEventLoopConfig(conf);</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> if (StringUtils.isBlank(name)) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> return null;</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"> return EVENT_LOOP_CONFIG_MAP.get(name);</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
