blob: 63a78fba51e706b6a9d65bee690490bfd0586545 [file] [log] [blame]
<!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.util, class: NettyUnsafeUtils">
<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.util;</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 org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hbase.thirdparty.io.netty.channel.Channel;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hbase.thirdparty.io.netty.channel.ChannelOption;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hbase.thirdparty.io.netty.channel.ChannelOutboundBuffer;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">/**</span>
<span class="source-line-no">027</span><span id="line-27"> * Wraps some usages of netty's unsafe API, for ease of maintainability.</span>
<span class="source-line-no">028</span><span id="line-28"> */</span>
<span class="source-line-no">029</span><span id="line-29">@InterfaceAudience.Private</span>
<span class="source-line-no">030</span><span id="line-30">public final class NettyUnsafeUtils {</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> private NettyUnsafeUtils() {</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"> /**</span>
<span class="source-line-no">036</span><span id="line-36"> * Directly closes the channel, setting SO_LINGER to 0 and skipping any handlers in the pipeline.</span>
<span class="source-line-no">037</span><span id="line-37"> * This is useful for cases where it's important to immediately close without any delay.</span>
<span class="source-line-no">038</span><span id="line-38"> * Otherwise, pipeline handlers and even general TCP flows can cause a normal close to take</span>
<span class="source-line-no">039</span><span id="line-39"> * upwards of a few second or more. This will likely cause the client side to see either a</span>
<span class="source-line-no">040</span><span id="line-40"> * "Connection reset by peer" or unexpected ConnectionClosedException.</span>
<span class="source-line-no">041</span><span id="line-41"> * &lt;p&gt;</span>
<span class="source-line-no">042</span><span id="line-42"> * &lt;b&gt;It's necessary to call this from within the channel's eventLoop!&lt;/b&gt;</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> public static void closeImmediately(Channel channel) {</span>
<span class="source-line-no">045</span><span id="line-45"> assert channel.eventLoop().inEventLoop();</span>
<span class="source-line-no">046</span><span id="line-46"> channel.config().setOption(ChannelOption.SO_LINGER, 0);</span>
<span class="source-line-no">047</span><span id="line-47"> channel.unsafe().close(channel.voidPromise());</span>
<span class="source-line-no">048</span><span id="line-48"> }</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> /**</span>
<span class="source-line-no">051</span><span id="line-51"> * Get total bytes pending write to socket</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53"> public static long getTotalPendingOutboundBytes(Channel channel) {</span>
<span class="source-line-no">054</span><span id="line-54"> ChannelOutboundBuffer outboundBuffer = channel.unsafe().outboundBuffer();</span>
<span class="source-line-no">055</span><span id="line-55"> // can be null when the channel is closing</span>
<span class="source-line-no">056</span><span id="line-56"> if (outboundBuffer == null) {</span>
<span class="source-line-no">057</span><span id="line-57"> return 0;</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"> return outboundBuffer.totalPendingWriteBytes();</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>
</pre>
</div>
</main>
</body>
</html>