| <!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: RpcScheduler, class: Context"> |
| <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.net.InetSocketAddress;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * An interface for RPC request scheduling algorithm.</span> |
| <span class="source-line-no">027</span><span id="line-27"> */</span> |
| <span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX })</span> |
| <span class="source-line-no">029</span><span id="line-29">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">030</span><span id="line-30">public abstract class RpcScheduler {</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32"> public static final String IPC_SERVER_MAX_CALLQUEUE_LENGTH =</span> |
| <span class="source-line-no">033</span><span id="line-33"> "hbase.ipc.server.max.callqueue.length";</span> |
| <span class="source-line-no">034</span><span id="line-34"> public static final String IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH =</span> |
| <span class="source-line-no">035</span><span id="line-35"> "hbase.ipc.server.priority.max.callqueue.length";</span> |
| <span class="source-line-no">036</span><span id="line-36"> public static final String IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH =</span> |
| <span class="source-line-no">037</span><span id="line-37"> "hbase.ipc.server.replication.max.callqueue.length";</span> |
| <span class="source-line-no">038</span><span id="line-38"> public static final String IPC_SERVER_BULKLOAD_MAX_CALLQUEUE_LENGTH =</span> |
| <span class="source-line-no">039</span><span id="line-39"> "hbase.ipc.server.bulkload.max.callqueue.length";</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> /** Exposes runtime information of a {@code RpcServer} that a {@code RpcScheduler} may need. */</span> |
| <span class="source-line-no">042</span><span id="line-42"> public static abstract class Context {</span> |
| <span class="source-line-no">043</span><span id="line-43"> public abstract InetSocketAddress getListenerAddress();</span> |
| <span class="source-line-no">044</span><span id="line-44"> }</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * Does some quick initialization. Heavy tasks (e.g. starting threads) should be done in</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@link #start()}. This method is called before {@code start}.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param context provides methods to retrieve runtime information from</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 abstract void init(Context context);</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Prepares for request serving. An implementation may start some handler threads here.</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56"> public abstract void start();</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /** Stops serving new requests. */</span> |
| <span class="source-line-no">059</span><span id="line-59"> public abstract void stop();</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Dispatches an RPC request asynchronously. An implementation is free to choose to process the</span> |
| <span class="source-line-no">063</span><span id="line-63"> * request immediately or delay it for later processing.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param task the request to be dispatched</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public abstract boolean dispatch(CallRunner task);</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /** Get call queue information **/</span> |
| <span class="source-line-no">069</span><span id="line-69"> public abstract CallQueueInfo getCallQueueInfo();</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /** Retrieves length of the general queue for metrics. */</span> |
| <span class="source-line-no">072</span><span id="line-72"> public abstract int getGeneralQueueLength();</span> |
| <span class="source-line-no">073</span><span id="line-73"></span> |
| <span class="source-line-no">074</span><span id="line-74"> /** Retrieves length of the priority queue for metrics. */</span> |
| <span class="source-line-no">075</span><span id="line-75"> public abstract int getPriorityQueueLength();</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /** Retrieves length of the meta priority queue for metrics. */</span> |
| <span class="source-line-no">078</span><span id="line-78"> public abstract int getMetaPriorityQueueLength();</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /** Retrieves length of the replication queue for metrics. */</span> |
| <span class="source-line-no">081</span><span id="line-81"> public abstract int getReplicationQueueLength();</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /** Retrieves length of the bulkload queue for metrics. */</span> |
| <span class="source-line-no">084</span><span id="line-84"> public abstract int getBulkLoadQueueLength();</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /** Retrieves the total number of active handler. */</span> |
| <span class="source-line-no">087</span><span id="line-87"> public abstract int getActiveRpcHandlerCount();</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /** Retrieves the number of active general handler. */</span> |
| <span class="source-line-no">090</span><span id="line-90"> public abstract int getActiveGeneralRpcHandlerCount();</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /** Retrieves the number of active priority handler. */</span> |
| <span class="source-line-no">093</span><span id="line-93"> public abstract int getActivePriorityRpcHandlerCount();</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /** Retrieves the number of active meta priority handler. */</span> |
| <span class="source-line-no">096</span><span id="line-96"> public abstract int getActiveMetaPriorityRpcHandlerCount();</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> /** Retrieves the number of active replication handler. */</span> |
| <span class="source-line-no">099</span><span id="line-99"> public abstract int getActiveReplicationRpcHandlerCount();</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> /** Retrieves the number of active bulkload handler. */</span> |
| <span class="source-line-no">102</span><span id="line-102"> public abstract int getActiveBulkLoadRpcHandlerCount();</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped from</span> |
| <span class="source-line-no">106</span><span id="line-106"> * general queue because RPC executor is under high load; returns 0 otherwise.</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> public abstract long getNumGeneralCallsDropped();</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> /**</span> |
| <span class="source-line-no">111</span><span id="line-111"> * If CoDel-based RPC executors are used, retrieves the number of Calls that were picked from the</span> |
| <span class="source-line-no">112</span><span id="line-112"> * tail of the queue (indicating adaptive LIFO mode, when in the period of overloade we serve last</span> |
| <span class="source-line-no">113</span><span id="line-113"> * requests first); returns 0 otherwise.</span> |
| <span class="source-line-no">114</span><span id="line-114"> */</span> |
| <span class="source-line-no">115</span><span id="line-115"> public abstract long getNumLifoModeSwitches();</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /** Retrieves length of the write queue for metrics when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">118</span><span id="line-118"> public abstract int getWriteQueueLength();</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /** Retrieves length of the read queue for metrics when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public abstract int getReadQueueLength();</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /** Retrieves length of the scan queue for metrics when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">124</span><span id="line-124"> public abstract int getScanQueueLength();</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /** Retrieves the number of active write rpc handler when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">127</span><span id="line-127"> public abstract int getActiveWriteRpcHandlerCount();</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /** Retrieves the number of active write rpc handler when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">130</span><span id="line-130"> public abstract int getActiveReadRpcHandlerCount();</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> /** Retrieves the number of active write rpc handler when use RWQueueRpcExecutor. */</span> |
| <span class="source-line-no">133</span><span id="line-133"> public abstract int getActiveScanRpcHandlerCount();</span> |
| <span class="source-line-no">134</span><span id="line-134">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
