| <!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.nio, class: ByteBuff"> |
| <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.nio;</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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.nio.channels.FileChannel;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.nio.channels.ReadableByteChannel;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.io.ByteBuffAllocator.Recycler;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.ObjectIntPair;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.io.netty.util.internal.ObjectUtil;</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"> * An abstract class that abstracts out as to how the byte buffers are used, either single or</span> |
| <span class="source-line-no">036</span><span id="line-36"> * multiple. We have this interface because the java's ByteBuffers cannot be sub-classed. This class</span> |
| <span class="source-line-no">037</span><span id="line-37"> * provides APIs similar to the ones provided in java's nio ByteBuffers and allows you to do</span> |
| <span class="source-line-no">038</span><span id="line-38"> * positional reads/writes and relative reads and writes on the underlying BB. In addition to it, we</span> |
| <span class="source-line-no">039</span><span id="line-39"> * have some additional APIs which helps us in the read path. <br/></span> |
| <span class="source-line-no">040</span><span id="line-40"> * The ByteBuff implement {@link HBaseReferenceCounted} interface which mean need to maintains a</span> |
| <span class="source-line-no">041</span><span id="line-41"> * {@link RefCnt} inside, if ensure that the ByteBuff won't be used any more, we must do a</span> |
| <span class="source-line-no">042</span><span id="line-42"> * {@link ByteBuff#release()} to recycle its NIO ByteBuffers. when considering the</span> |
| <span class="source-line-no">043</span><span id="line-43"> * {@link ByteBuff#duplicate()} or {@link ByteBuff#slice()}, releasing either the duplicated one or</span> |
| <span class="source-line-no">044</span><span id="line-44"> * the original one will free its memory, because they share the same NIO ByteBuffers. when you want</span> |
| <span class="source-line-no">045</span><span id="line-45"> * to retain the NIO ByteBuffers even if the origin one called {@link ByteBuff#release()}, you can</span> |
| <span class="source-line-no">046</span><span id="line-46"> * do like this:</span> |
| <span class="source-line-no">047</span><span id="line-47"> *</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <pre></span> |
| <span class="source-line-no">049</span><span id="line-49"> * ByteBuff original = ...;</span> |
| <span class="source-line-no">050</span><span id="line-50"> * ByteBuff dup = original.duplicate();</span> |
| <span class="source-line-no">051</span><span id="line-51"> * dup.retain();</span> |
| <span class="source-line-no">052</span><span id="line-52"> * original.release();</span> |
| <span class="source-line-no">053</span><span id="line-53"> * // The NIO buffers can still be accessed unless you release the duplicated one</span> |
| <span class="source-line-no">054</span><span id="line-54"> * dup.get(...);</span> |
| <span class="source-line-no">055</span><span id="line-55"> * dup.release();</span> |
| <span class="source-line-no">056</span><span id="line-56"> * // Both the original and dup can not access the NIO buffers any more.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * </pre></span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59">@InterfaceAudience.Private</span> |
| <span class="source-line-no">060</span><span id="line-60">public abstract class ByteBuff implements HBaseReferenceCounted {</span> |
| <span class="source-line-no">061</span><span id="line-61"> private static final String REFERENCE_COUNT_NAME = "ReferenceCount";</span> |
| <span class="source-line-no">062</span><span id="line-62"> private static final int NIO_BUFFER_LIMIT = 64 * 1024; // should not be more than 64KB.</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> protected RefCnt refCnt;</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /*************************** Methods for reference count **********************************/</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /**</span> |
| <span class="source-line-no">069</span><span id="line-69"> * Checks that there are still references to the buffer. This protects against the case where a</span> |
| <span class="source-line-no">070</span><span id="line-70"> * ByteBuff method (i.e. slice, get, etc) could be called against a buffer whose backing data may</span> |
| <span class="source-line-no">071</span><span id="line-71"> * have been released. We only need to do this check if the refCnt has a recycler. If there's no</span> |
| <span class="source-line-no">072</span><span id="line-72"> * recycler, the backing data will be handled by normal java GC and won't get incorrectly</span> |
| <span class="source-line-no">073</span><span id="line-73"> * released. So we can avoid the overhead of checking the refCnt on every call. See HBASE-27710.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> protected void checkRefCount() {</span> |
| <span class="source-line-no">076</span><span id="line-76"> if (refCnt.hasRecycler()) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> ObjectUtil.checkPositive(refCnt(), REFERENCE_COUNT_NAME);</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> @Override</span> |
| <span class="source-line-no">082</span><span id="line-82"> public int refCnt() {</span> |
| <span class="source-line-no">083</span><span id="line-83"> return refCnt.refCnt();</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> @Override</span> |
| <span class="source-line-no">087</span><span id="line-87"> public boolean release() {</span> |
| <span class="source-line-no">088</span><span id="line-88"> return refCnt.release();</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /******************************* Methods for ByteBuff **************************************/</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /** Returns this ByteBuff's current position */</span> |
| <span class="source-line-no">094</span><span id="line-94"> public abstract int position();</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Sets this ByteBuff's position to the given value.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @return this object</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> public abstract ByteBuff position(int position);</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Jumps the current position of this ByteBuff by specified length.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @param len the length to be skipped</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> public abstract ByteBuff skip(int len);</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * Jumps back the current position of this ByteBuff by specified length.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @param len the length to move back</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> public abstract ByteBuff moveBack(int len);</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /** Returns the total capacity of this ByteBuff. */</span> |
| <span class="source-line-no">115</span><span id="line-115"> public abstract int capacity();</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /** Returns the limit of this ByteBuff */</span> |
| <span class="source-line-no">118</span><span id="line-118"> public abstract int limit();</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /** Marks the limit of this ByteBuff */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public abstract ByteBuff limit(int limit);</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /** Rewinds this ByteBuff and the position is set to 0 */</span> |
| <span class="source-line-no">124</span><span id="line-124"> public abstract ByteBuff rewind();</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /** Marks the current position of the ByteBuff */</span> |
| <span class="source-line-no">127</span><span id="line-127"> public abstract ByteBuff mark();</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Returns bytes from current position till length specified, as a single ByteBuffer. When all</span> |
| <span class="source-line-no">131</span><span id="line-131"> * these bytes happen to be in a single ByteBuffer, which this object wraps, that ByteBuffer item</span> |
| <span class="source-line-no">132</span><span id="line-132"> * as such will be returned. So users are warned not to change the position or limit of this</span> |
| <span class="source-line-no">133</span><span id="line-133"> * returned ByteBuffer. The position of the returned byte buffer is at the begin of the required</span> |
| <span class="source-line-no">134</span><span id="line-134"> * bytes. When the required bytes happen to span across multiple ByteBuffers, this API will copy</span> |
| <span class="source-line-no">135</span><span id="line-135"> * the bytes to a newly created ByteBuffer of required size and return that.</span> |
| <span class="source-line-no">136</span><span id="line-136"> * @param length number of bytes required.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return bytes from current position till length specified, as a single ByteButter.</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> public abstract ByteBuffer asSubByteBuffer(int length);</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * Returns bytes from given offset till length specified, as a single ByteBuffer. When all these</span> |
| <span class="source-line-no">143</span><span id="line-143"> * bytes happen to be in a single ByteBuffer, which this object wraps, that ByteBuffer item as</span> |
| <span class="source-line-no">144</span><span id="line-144"> * such will be returned (with offset in this ByteBuffer where the bytes starts). So users are</span> |
| <span class="source-line-no">145</span><span id="line-145"> * warned not to change the position or limit of this returned ByteBuffer. When the required bytes</span> |
| <span class="source-line-no">146</span><span id="line-146"> * happen to span across multiple ByteBuffers, this API will copy the bytes to a newly created</span> |
| <span class="source-line-no">147</span><span id="line-147"> * ByteBuffer of required size and return that.</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @param offset the offset in this ByteBuff from where the subBuffer should be created</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @param length the length of the subBuffer</span> |
| <span class="source-line-no">150</span><span id="line-150"> * @param pair a pair that will have the bytes from the current position till length specified,</span> |
| <span class="source-line-no">151</span><span id="line-151"> * as a single ByteBuffer and offset in that Buffer where the bytes starts. Since</span> |
| <span class="source-line-no">152</span><span id="line-152"> * this API gets called in a loop we are passing a pair to it which could be created</span> |
| <span class="source-line-no">153</span><span id="line-153"> * outside the loop and the method would set the values on the pair that is passed</span> |
| <span class="source-line-no">154</span><span id="line-154"> * in by the caller. Thus it avoids more object creations that would happen if the</span> |
| <span class="source-line-no">155</span><span id="line-155"> * pair that is returned is created by this method every time.</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> public abstract void asSubByteBuffer(int offset, int length, ObjectIntPair<ByteBuffer> pair);</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> /** Returns the number of elements between the current position and the limit. */</span> |
| <span class="source-line-no">160</span><span id="line-160"> public abstract int remaining();</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> /** Returns true if there are elements between the current position and the limit. */</span> |
| <span class="source-line-no">163</span><span id="line-163"> public abstract boolean hasRemaining();</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> /**</span> |
| <span class="source-line-no">166</span><span id="line-166"> * Similar to {@link ByteBuffer}.reset(), ensures that this ByteBuff is reset back to last marked</span> |
| <span class="source-line-no">167</span><span id="line-167"> * position.</span> |
| <span class="source-line-no">168</span><span id="line-168"> * @return This ByteBuff</span> |
| <span class="source-line-no">169</span><span id="line-169"> */</span> |
| <span class="source-line-no">170</span><span id="line-170"> public abstract ByteBuff reset();</span> |
| <span class="source-line-no">171</span><span id="line-171"></span> |
| <span class="source-line-no">172</span><span id="line-172"> /**</span> |
| <span class="source-line-no">173</span><span id="line-173"> * Returns an ByteBuff which is a sliced version of this ByteBuff. The position, limit and mark of</span> |
| <span class="source-line-no">174</span><span id="line-174"> * the new ByteBuff will be independent than that of the original ByteBuff. The content of the new</span> |
| <span class="source-line-no">175</span><span id="line-175"> * ByteBuff will start at this ByteBuff's current position</span> |
| <span class="source-line-no">176</span><span id="line-176"> * @return a sliced ByteBuff</span> |
| <span class="source-line-no">177</span><span id="line-177"> */</span> |
| <span class="source-line-no">178</span><span id="line-178"> public abstract ByteBuff slice();</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Returns an ByteBuff which is a duplicate version of this ByteBuff. The position, limit and mark</span> |
| <span class="source-line-no">182</span><span id="line-182"> * of the new ByteBuff will be independent than that of the original ByteBuff. The content of the</span> |
| <span class="source-line-no">183</span><span id="line-183"> * new ByteBuff will start at this ByteBuff's current position The position, limit and mark of the</span> |
| <span class="source-line-no">184</span><span id="line-184"> * new ByteBuff would be identical to this ByteBuff in terms of values.</span> |
| <span class="source-line-no">185</span><span id="line-185"> * @return a sliced ByteBuff</span> |
| <span class="source-line-no">186</span><span id="line-186"> */</span> |
| <span class="source-line-no">187</span><span id="line-187"> public abstract ByteBuff duplicate();</span> |
| <span class="source-line-no">188</span><span id="line-188"></span> |
| <span class="source-line-no">189</span><span id="line-189"> /**</span> |
| <span class="source-line-no">190</span><span id="line-190"> * A relative method that returns byte at the current position. Increments the current position by</span> |
| <span class="source-line-no">191</span><span id="line-191"> * the size of a byte.</span> |
| <span class="source-line-no">192</span><span id="line-192"> * @return the byte at the current position</span> |
| <span class="source-line-no">193</span><span id="line-193"> */</span> |
| <span class="source-line-no">194</span><span id="line-194"> public abstract byte get();</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> /**</span> |
| <span class="source-line-no">197</span><span id="line-197"> * Fetches the byte at the given index. Does not change position of the underlying ByteBuffers</span> |
| <span class="source-line-no">198</span><span id="line-198"> * @return the byte at the given index</span> |
| <span class="source-line-no">199</span><span id="line-199"> */</span> |
| <span class="source-line-no">200</span><span id="line-200"> public abstract byte get(int index);</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> /**</span> |
| <span class="source-line-no">203</span><span id="line-203"> * Fetches the byte at the given offset from current position. Does not change position of the</span> |
| <span class="source-line-no">204</span><span id="line-204"> * underlying ByteBuffers.</span> |
| <span class="source-line-no">205</span><span id="line-205"> * @return the byte value at the given index.</span> |
| <span class="source-line-no">206</span><span id="line-206"> */</span> |
| <span class="source-line-no">207</span><span id="line-207"> public abstract byte getByteAfterPosition(int offset);</span> |
| <span class="source-line-no">208</span><span id="line-208"></span> |
| <span class="source-line-no">209</span><span id="line-209"> /**</span> |
| <span class="source-line-no">210</span><span id="line-210"> * Writes a byte to this ByteBuff at the current position and increments the position</span> |
| <span class="source-line-no">211</span><span id="line-211"> * @return this object</span> |
| <span class="source-line-no">212</span><span id="line-212"> */</span> |
| <span class="source-line-no">213</span><span id="line-213"> public abstract ByteBuff put(byte b);</span> |
| <span class="source-line-no">214</span><span id="line-214"></span> |
| <span class="source-line-no">215</span><span id="line-215"> /**</span> |
| <span class="source-line-no">216</span><span id="line-216"> * Writes a byte to this ByteBuff at the given index</span> |
| <span class="source-line-no">217</span><span id="line-217"> * @return this object</span> |
| <span class="source-line-no">218</span><span id="line-218"> */</span> |
| <span class="source-line-no">219</span><span id="line-219"> public abstract ByteBuff put(int index, byte b);</span> |
| <span class="source-line-no">220</span><span id="line-220"></span> |
| <span class="source-line-no">221</span><span id="line-221"> /**</span> |
| <span class="source-line-no">222</span><span id="line-222"> * Copies the specified number of bytes from this ByteBuff's current position to the byte[]'s</span> |
| <span class="source-line-no">223</span><span id="line-223"> * offset. Also advances the position of the ByteBuff by the given length.</span> |
| <span class="source-line-no">224</span><span id="line-224"> * @param dst the byte[] to which the ByteBuff's content is to be copied</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @param offset within the current array</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @param length upto which the bytes to be copied</span> |
| <span class="source-line-no">227</span><span id="line-227"> */</span> |
| <span class="source-line-no">228</span><span id="line-228"> public abstract void get(byte[] dst, int offset, int length);</span> |
| <span class="source-line-no">229</span><span id="line-229"></span> |
| <span class="source-line-no">230</span><span id="line-230"> /**</span> |
| <span class="source-line-no">231</span><span id="line-231"> * Copies the specified number of bytes from this ByteBuff's given position to the byte[]'s</span> |
| <span class="source-line-no">232</span><span id="line-232"> * offset. The position of the ByteBuff remains in the current position only</span> |
| <span class="source-line-no">233</span><span id="line-233"> * @param sourceOffset the offset in this ByteBuff from where the copy should happen</span> |
| <span class="source-line-no">234</span><span id="line-234"> * @param dst the byte[] to which the ByteBuff's content is to be copied</span> |
| <span class="source-line-no">235</span><span id="line-235"> * @param offset within the current array</span> |
| <span class="source-line-no">236</span><span id="line-236"> * @param length upto which the bytes to be copied</span> |
| <span class="source-line-no">237</span><span id="line-237"> */</span> |
| <span class="source-line-no">238</span><span id="line-238"> public abstract void get(int sourceOffset, byte[] dst, int offset, int length);</span> |
| <span class="source-line-no">239</span><span id="line-239"></span> |
| <span class="source-line-no">240</span><span id="line-240"> /**</span> |
| <span class="source-line-no">241</span><span id="line-241"> * Copies the content from this ByteBuff's current position to the byte array and fills it. Also</span> |
| <span class="source-line-no">242</span><span id="line-242"> * advances the position of the ByteBuff by the length of the byte[].</span> |
| <span class="source-line-no">243</span><span id="line-243"> * @param dst the byte[] to which the ByteBuff's content is to be copied</span> |
| <span class="source-line-no">244</span><span id="line-244"> */</span> |
| <span class="source-line-no">245</span><span id="line-245"> public abstract void get(byte[] dst);</span> |
| <span class="source-line-no">246</span><span id="line-246"></span> |
| <span class="source-line-no">247</span><span id="line-247"> /**</span> |
| <span class="source-line-no">248</span><span id="line-248"> * Copies from the given byte[] to this ByteBuff</span> |
| <span class="source-line-no">249</span><span id="line-249"> * @param src source byte array</span> |
| <span class="source-line-no">250</span><span id="line-250"> * @param offset the position in the byte array from which the copy should be done</span> |
| <span class="source-line-no">251</span><span id="line-251"> * @param length the length upto which the copy should happen</span> |
| <span class="source-line-no">252</span><span id="line-252"> * @return this ByteBuff</span> |
| <span class="source-line-no">253</span><span id="line-253"> */</span> |
| <span class="source-line-no">254</span><span id="line-254"> public abstract ByteBuff put(byte[] src, int offset, int length);</span> |
| <span class="source-line-no">255</span><span id="line-255"></span> |
| <span class="source-line-no">256</span><span id="line-256"> /**</span> |
| <span class="source-line-no">257</span><span id="line-257"> * Copies from the given byte[] to this ByteBuff</span> |
| <span class="source-line-no">258</span><span id="line-258"> * @return this ByteBuff</span> |
| <span class="source-line-no">259</span><span id="line-259"> * @param src source byte array</span> |
| <span class="source-line-no">260</span><span id="line-260"> * @return this ByteBuff</span> |
| <span class="source-line-no">261</span><span id="line-261"> */</span> |
| <span class="source-line-no">262</span><span id="line-262"> public abstract ByteBuff put(byte[] src);</span> |
| <span class="source-line-no">263</span><span id="line-263"></span> |
| <span class="source-line-no">264</span><span id="line-264"> /** Returns true or false if the underlying BB support hasArray */</span> |
| <span class="source-line-no">265</span><span id="line-265"> public abstract boolean hasArray();</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> /** Returns the byte[] if the underlying BB has single BB and hasArray true */</span> |
| <span class="source-line-no">268</span><span id="line-268"> public abstract byte[] array();</span> |
| <span class="source-line-no">269</span><span id="line-269"></span> |
| <span class="source-line-no">270</span><span id="line-270"> /** Returns the arrayOffset of the byte[] incase of a single BB backed ByteBuff */</span> |
| <span class="source-line-no">271</span><span id="line-271"> public abstract int arrayOffset();</span> |
| <span class="source-line-no">272</span><span id="line-272"></span> |
| <span class="source-line-no">273</span><span id="line-273"> /**</span> |
| <span class="source-line-no">274</span><span id="line-274"> * Returns the short value at the current position. Also advances the position by the size of</span> |
| <span class="source-line-no">275</span><span id="line-275"> * short.</span> |
| <span class="source-line-no">276</span><span id="line-276"> */</span> |
| <span class="source-line-no">277</span><span id="line-277"> public abstract short getShort();</span> |
| <span class="source-line-no">278</span><span id="line-278"></span> |
| <span class="source-line-no">279</span><span id="line-279"> /**</span> |
| <span class="source-line-no">280</span><span id="line-280"> * Fetches the short value at the given index. Does not change position of the underlying</span> |
| <span class="source-line-no">281</span><span id="line-281"> * ByteBuffers. The caller is sure that the index will be after the current position of this</span> |
| <span class="source-line-no">282</span><span id="line-282"> * ByteBuff. So even if the current short does not fit in the current item we can safely move to</span> |
| <span class="source-line-no">283</span><span id="line-283"> * the next item and fetch the remaining bytes forming the short</span> |
| <span class="source-line-no">284</span><span id="line-284"> * @return the short value at the given index</span> |
| <span class="source-line-no">285</span><span id="line-285"> */</span> |
| <span class="source-line-no">286</span><span id="line-286"> public abstract short getShort(int index);</span> |
| <span class="source-line-no">287</span><span id="line-287"></span> |
| <span class="source-line-no">288</span><span id="line-288"> /**</span> |
| <span class="source-line-no">289</span><span id="line-289"> * Fetches the short value at the given offset from current position. Does not change position of</span> |
| <span class="source-line-no">290</span><span id="line-290"> * the underlying ByteBuffers.</span> |
| <span class="source-line-no">291</span><span id="line-291"> * @return the short value at the given index.</span> |
| <span class="source-line-no">292</span><span id="line-292"> */</span> |
| <span class="source-line-no">293</span><span id="line-293"> public abstract short getShortAfterPosition(int offset);</span> |
| <span class="source-line-no">294</span><span id="line-294"></span> |
| <span class="source-line-no">295</span><span id="line-295"> /**</span> |
| <span class="source-line-no">296</span><span id="line-296"> * Returns the int value at the current position. Also advances the position by the size of int.</span> |
| <span class="source-line-no">297</span><span id="line-297"> */</span> |
| <span class="source-line-no">298</span><span id="line-298"> public abstract int getInt();</span> |
| <span class="source-line-no">299</span><span id="line-299"></span> |
| <span class="source-line-no">300</span><span id="line-300"> /**</span> |
| <span class="source-line-no">301</span><span id="line-301"> * Writes an int to this ByteBuff at its current position. Also advances the position by size of</span> |
| <span class="source-line-no">302</span><span id="line-302"> * int.</span> |
| <span class="source-line-no">303</span><span id="line-303"> */</span> |
| <span class="source-line-no">304</span><span id="line-304"> public abstract ByteBuff putInt(int value);</span> |
| <span class="source-line-no">305</span><span id="line-305"></span> |
| <span class="source-line-no">306</span><span id="line-306"> /**</span> |
| <span class="source-line-no">307</span><span id="line-307"> * Fetches the int at the given index. Does not change position of the underlying ByteBuffers.</span> |
| <span class="source-line-no">308</span><span id="line-308"> * Even if the current int does not fit in the current item we can safely move to the next item</span> |
| <span class="source-line-no">309</span><span id="line-309"> * and fetch the remaining bytes forming the int.</span> |
| <span class="source-line-no">310</span><span id="line-310"> */</span> |
| <span class="source-line-no">311</span><span id="line-311"> public abstract int getInt(int index);</span> |
| <span class="source-line-no">312</span><span id="line-312"></span> |
| <span class="source-line-no">313</span><span id="line-313"> /**</span> |
| <span class="source-line-no">314</span><span id="line-314"> * Fetches the int value at the given offset from current position. Does not change position of</span> |
| <span class="source-line-no">315</span><span id="line-315"> * the underlying ByteBuffers.</span> |
| <span class="source-line-no">316</span><span id="line-316"> */</span> |
| <span class="source-line-no">317</span><span id="line-317"> public abstract int getIntAfterPosition(int offset);</span> |
| <span class="source-line-no">318</span><span id="line-318"></span> |
| <span class="source-line-no">319</span><span id="line-319"> /**</span> |
| <span class="source-line-no">320</span><span id="line-320"> * Returns the long value at the current position. Also advances the position by the size of long.</span> |
| <span class="source-line-no">321</span><span id="line-321"> */</span> |
| <span class="source-line-no">322</span><span id="line-322"> public abstract long getLong();</span> |
| <span class="source-line-no">323</span><span id="line-323"></span> |
| <span class="source-line-no">324</span><span id="line-324"> /**</span> |
| <span class="source-line-no">325</span><span id="line-325"> * Writes a long to this ByteBuff at its current position. Also advances the position by size of</span> |
| <span class="source-line-no">326</span><span id="line-326"> * long.</span> |
| <span class="source-line-no">327</span><span id="line-327"> */</span> |
| <span class="source-line-no">328</span><span id="line-328"> public abstract ByteBuff putLong(long value);</span> |
| <span class="source-line-no">329</span><span id="line-329"></span> |
| <span class="source-line-no">330</span><span id="line-330"> /**</span> |
| <span class="source-line-no">331</span><span id="line-331"> * Fetches the long at the given index. Does not change position of the underlying ByteBuffers.</span> |
| <span class="source-line-no">332</span><span id="line-332"> * The caller is sure that the index will be after the current position of this ByteBuff. So even</span> |
| <span class="source-line-no">333</span><span id="line-333"> * if the current long does not fit in the current item we can safely move to the next item and</span> |
| <span class="source-line-no">334</span><span id="line-334"> * fetch the remaining bytes forming the long</span> |
| <span class="source-line-no">335</span><span id="line-335"> * @return the long value at the given index</span> |
| <span class="source-line-no">336</span><span id="line-336"> */</span> |
| <span class="source-line-no">337</span><span id="line-337"> public abstract long getLong(int index);</span> |
| <span class="source-line-no">338</span><span id="line-338"></span> |
| <span class="source-line-no">339</span><span id="line-339"> /**</span> |
| <span class="source-line-no">340</span><span id="line-340"> * Fetches the long value at the given offset from current position. Does not change position of</span> |
| <span class="source-line-no">341</span><span id="line-341"> * the underlying ByteBuffers.</span> |
| <span class="source-line-no">342</span><span id="line-342"> * @return the long value at the given index.</span> |
| <span class="source-line-no">343</span><span id="line-343"> */</span> |
| <span class="source-line-no">344</span><span id="line-344"> public abstract long getLongAfterPosition(int offset);</span> |
| <span class="source-line-no">345</span><span id="line-345"></span> |
| <span class="source-line-no">346</span><span id="line-346"> /**</span> |
| <span class="source-line-no">347</span><span id="line-347"> * Copy the content from this ByteBuff to a byte[].</span> |
| <span class="source-line-no">348</span><span id="line-348"> */</span> |
| <span class="source-line-no">349</span><span id="line-349"> public byte[] toBytes() {</span> |
| <span class="source-line-no">350</span><span id="line-350"> return toBytes(0, this.limit());</span> |
| <span class="source-line-no">351</span><span id="line-351"> }</span> |
| <span class="source-line-no">352</span><span id="line-352"></span> |
| <span class="source-line-no">353</span><span id="line-353"> /**</span> |
| <span class="source-line-no">354</span><span id="line-354"> * Copy the content from this ByteBuff to a byte[] based on the given offset and length.</span> |
| <span class="source-line-no">355</span><span id="line-355"> */</span> |
| <span class="source-line-no">356</span><span id="line-356"> public abstract byte[] toBytes(int offset, int length);</span> |
| <span class="source-line-no">357</span><span id="line-357"></span> |
| <span class="source-line-no">358</span><span id="line-358"> /**</span> |
| <span class="source-line-no">359</span><span id="line-359"> * Copies the content from this ByteBuff to a ByteBuffer Note : This will advance the position</span> |
| <span class="source-line-no">360</span><span id="line-360"> * marker of {@code out} but not change the position maker for this ByteBuff</span> |
| <span class="source-line-no">361</span><span id="line-361"> * @param out the ByteBuffer to which the copy has to happen</span> |
| <span class="source-line-no">362</span><span id="line-362"> * @param sourceOffset the offset in the ByteBuff from which the elements has to be copied</span> |
| <span class="source-line-no">363</span><span id="line-363"> * @param length the length in this ByteBuff upto which the elements has to be copied</span> |
| <span class="source-line-no">364</span><span id="line-364"> */</span> |
| <span class="source-line-no">365</span><span id="line-365"> public abstract void get(ByteBuffer out, int sourceOffset, int length);</span> |
| <span class="source-line-no">366</span><span id="line-366"></span> |
| <span class="source-line-no">367</span><span id="line-367"> /**</span> |
| <span class="source-line-no">368</span><span id="line-368"> * Copies the contents from the src ByteBuff to this ByteBuff. This will be absolute positional</span> |
| <span class="source-line-no">369</span><span id="line-369"> * copying and won't affect the position of any of the buffers.</span> |
| <span class="source-line-no">370</span><span id="line-370"> * @param offset the position in this ByteBuff to which the copy should happen</span> |
| <span class="source-line-no">371</span><span id="line-371"> * @param src the src ByteBuff</span> |
| <span class="source-line-no">372</span><span id="line-372"> * @param srcOffset the offset in the src ByteBuff from where the elements should be read</span> |
| <span class="source-line-no">373</span><span id="line-373"> * @param length the length up to which the copy should happen</span> |
| <span class="source-line-no">374</span><span id="line-374"> */</span> |
| <span class="source-line-no">375</span><span id="line-375"> public abstract ByteBuff put(int offset, ByteBuff src, int srcOffset, int length);</span> |
| <span class="source-line-no">376</span><span id="line-376"></span> |
| <span class="source-line-no">377</span><span id="line-377"> /** Reads bytes from the given channel into this ByteBuf. */</span> |
| <span class="source-line-no">378</span><span id="line-378"> public abstract int read(ReadableByteChannel channel) throws IOException;</span> |
| <span class="source-line-no">379</span><span id="line-379"></span> |
| <span class="source-line-no">380</span><span id="line-380"> /** Reads bytes from FileChannel into this ByteBuff */</span> |
| <span class="source-line-no">381</span><span id="line-381"> public abstract int read(FileChannel channel, long offset) throws IOException;</span> |
| <span class="source-line-no">382</span><span id="line-382"></span> |
| <span class="source-line-no">383</span><span id="line-383"> /** Write this ByteBuff's data into target file */</span> |
| <span class="source-line-no">384</span><span id="line-384"> public abstract int write(FileChannel channel, long offset) throws IOException;</span> |
| <span class="source-line-no">385</span><span id="line-385"></span> |
| <span class="source-line-no">386</span><span id="line-386"> /** Functional interface for Channel read */</span> |
| <span class="source-line-no">387</span><span id="line-387"> @FunctionalInterface</span> |
| <span class="source-line-no">388</span><span id="line-388"> interface ChannelReader {</span> |
| <span class="source-line-no">389</span><span id="line-389"> int read(ReadableByteChannel channel, ByteBuffer buf, long offset) throws IOException;</span> |
| <span class="source-line-no">390</span><span id="line-390"> }</span> |
| <span class="source-line-no">391</span><span id="line-391"></span> |
| <span class="source-line-no">392</span><span id="line-392"> static final ChannelReader CHANNEL_READER = (channel, buf, offset) -> {</span> |
| <span class="source-line-no">393</span><span id="line-393"> return channel.read(buf);</span> |
| <span class="source-line-no">394</span><span id="line-394"> };</span> |
| <span class="source-line-no">395</span><span id="line-395"></span> |
| <span class="source-line-no">396</span><span id="line-396"> static final ChannelReader FILE_READER = (channel, buf, offset) -> {</span> |
| <span class="source-line-no">397</span><span id="line-397"> return ((FileChannel) channel).read(buf, offset);</span> |
| <span class="source-line-no">398</span><span id="line-398"> };</span> |
| <span class="source-line-no">399</span><span id="line-399"></span> |
| <span class="source-line-no">400</span><span id="line-400"> // static helper methods</span> |
| <span class="source-line-no">401</span><span id="line-401"> public static int read(ReadableByteChannel channel, ByteBuffer buf, long offset,</span> |
| <span class="source-line-no">402</span><span id="line-402"> ChannelReader reader) throws IOException {</span> |
| <span class="source-line-no">403</span><span id="line-403"> if (buf.remaining() <= NIO_BUFFER_LIMIT) {</span> |
| <span class="source-line-no">404</span><span id="line-404"> return reader.read(channel, buf, offset);</span> |
| <span class="source-line-no">405</span><span id="line-405"> }</span> |
| <span class="source-line-no">406</span><span id="line-406"> int originalLimit = buf.limit();</span> |
| <span class="source-line-no">407</span><span id="line-407"> int initialRemaining = buf.remaining();</span> |
| <span class="source-line-no">408</span><span id="line-408"> int ret = 0;</span> |
| <span class="source-line-no">409</span><span id="line-409"></span> |
| <span class="source-line-no">410</span><span id="line-410"> while (buf.remaining() > 0) {</span> |
| <span class="source-line-no">411</span><span id="line-411"> try {</span> |
| <span class="source-line-no">412</span><span id="line-412"> int ioSize = Math.min(buf.remaining(), NIO_BUFFER_LIMIT);</span> |
| <span class="source-line-no">413</span><span id="line-413"> buf.limit(buf.position() + ioSize);</span> |
| <span class="source-line-no">414</span><span id="line-414"> offset += ret;</span> |
| <span class="source-line-no">415</span><span id="line-415"> ret = reader.read(channel, buf, offset);</span> |
| <span class="source-line-no">416</span><span id="line-416"> if (ret < ioSize) {</span> |
| <span class="source-line-no">417</span><span id="line-417"> break;</span> |
| <span class="source-line-no">418</span><span id="line-418"> }</span> |
| <span class="source-line-no">419</span><span id="line-419"> } finally {</span> |
| <span class="source-line-no">420</span><span id="line-420"> buf.limit(originalLimit);</span> |
| <span class="source-line-no">421</span><span id="line-421"> }</span> |
| <span class="source-line-no">422</span><span id="line-422"> }</span> |
| <span class="source-line-no">423</span><span id="line-423"> int nBytes = initialRemaining - buf.remaining();</span> |
| <span class="source-line-no">424</span><span id="line-424"> return (nBytes > 0) ? nBytes : ret;</span> |
| <span class="source-line-no">425</span><span id="line-425"> }</span> |
| <span class="source-line-no">426</span><span id="line-426"></span> |
| <span class="source-line-no">427</span><span id="line-427"> /** Read integer from ByteBuff coded in 7 bits and increment position. */</span> |
| <span class="source-line-no">428</span><span id="line-428"> public static int readCompressedInt(ByteBuff buf) {</span> |
| <span class="source-line-no">429</span><span id="line-429"> byte b = buf.get();</span> |
| <span class="source-line-no">430</span><span id="line-430"> if ((b & ByteBufferUtils.NEXT_BIT_MASK) != 0) {</span> |
| <span class="source-line-no">431</span><span id="line-431"> return (b & ByteBufferUtils.VALUE_MASK)</span> |
| <span class="source-line-no">432</span><span id="line-432"> + (readCompressedInt(buf) << ByteBufferUtils.NEXT_BIT_SHIFT);</span> |
| <span class="source-line-no">433</span><span id="line-433"> }</span> |
| <span class="source-line-no">434</span><span id="line-434"> return b & ByteBufferUtils.VALUE_MASK;</span> |
| <span class="source-line-no">435</span><span id="line-435"> }</span> |
| <span class="source-line-no">436</span><span id="line-436"></span> |
| <span class="source-line-no">437</span><span id="line-437"> /**</span> |
| <span class="source-line-no">438</span><span id="line-438"> * Compares two ByteBuffs</span> |
| <span class="source-line-no">439</span><span id="line-439"> * @param buf1 the first ByteBuff</span> |
| <span class="source-line-no">440</span><span id="line-440"> * @param o1 the offset in the first ByteBuff from where the compare has to happen</span> |
| <span class="source-line-no">441</span><span id="line-441"> * @param len1 the length in the first ByteBuff upto which the compare has to happen</span> |
| <span class="source-line-no">442</span><span id="line-442"> * @param buf2 the second ByteBuff</span> |
| <span class="source-line-no">443</span><span id="line-443"> * @param o2 the offset in the second ByteBuff from where the compare has to happen</span> |
| <span class="source-line-no">444</span><span id="line-444"> * @param len2 the length in the second ByteBuff upto which the compare has to happen</span> |
| <span class="source-line-no">445</span><span id="line-445"> * @return Positive if buf1 is bigger than buf2, 0 if they are equal, and negative if buf1 is</span> |
| <span class="source-line-no">446</span><span id="line-446"> * smaller than buf2.</span> |
| <span class="source-line-no">447</span><span id="line-447"> */</span> |
| <span class="source-line-no">448</span><span id="line-448"> public static int compareTo(ByteBuff buf1, int o1, int len1, ByteBuff buf2, int o2, int len2) {</span> |
| <span class="source-line-no">449</span><span id="line-449"> if (buf1.hasArray() && buf2.hasArray()) {</span> |
| <span class="source-line-no">450</span><span id="line-450"> return Bytes.compareTo(buf1.array(), buf1.arrayOffset() + o1, len1, buf2.array(),</span> |
| <span class="source-line-no">451</span><span id="line-451"> buf2.arrayOffset() + o2, len2);</span> |
| <span class="source-line-no">452</span><span id="line-452"> }</span> |
| <span class="source-line-no">453</span><span id="line-453"> int end1 = o1 + len1;</span> |
| <span class="source-line-no">454</span><span id="line-454"> int end2 = o2 + len2;</span> |
| <span class="source-line-no">455</span><span id="line-455"> for (int i = o1, j = o2; i < end1 && j < end2; i++, j++) {</span> |
| <span class="source-line-no">456</span><span id="line-456"> int a = buf1.get(i) & 0xFF;</span> |
| <span class="source-line-no">457</span><span id="line-457"> int b = buf2.get(j) & 0xFF;</span> |
| <span class="source-line-no">458</span><span id="line-458"> if (a != b) {</span> |
| <span class="source-line-no">459</span><span id="line-459"> return a - b;</span> |
| <span class="source-line-no">460</span><span id="line-460"> }</span> |
| <span class="source-line-no">461</span><span id="line-461"> }</span> |
| <span class="source-line-no">462</span><span id="line-462"> return len1 - len2;</span> |
| <span class="source-line-no">463</span><span id="line-463"> }</span> |
| <span class="source-line-no">464</span><span id="line-464"></span> |
| <span class="source-line-no">465</span><span id="line-465"> /**</span> |
| <span class="source-line-no">466</span><span id="line-466"> * Read long which was written to fitInBytes bytes and increment position.</span> |
| <span class="source-line-no">467</span><span id="line-467"> * @param fitInBytes In how many bytes given long is stored.</span> |
| <span class="source-line-no">468</span><span id="line-468"> * @return The value of parsed long.</span> |
| <span class="source-line-no">469</span><span id="line-469"> */</span> |
| <span class="source-line-no">470</span><span id="line-470"> public static long readLong(ByteBuff in, final int fitInBytes) {</span> |
| <span class="source-line-no">471</span><span id="line-471"> long tmpLength = 0;</span> |
| <span class="source-line-no">472</span><span id="line-472"> for (int i = 0; i < fitInBytes; ++i) {</span> |
| <span class="source-line-no">473</span><span id="line-473"> tmpLength |= (in.get() & 0xffl) << (8l * i);</span> |
| <span class="source-line-no">474</span><span id="line-474"> }</span> |
| <span class="source-line-no">475</span><span id="line-475"> return tmpLength;</span> |
| <span class="source-line-no">476</span><span id="line-476"> }</span> |
| <span class="source-line-no">477</span><span id="line-477"></span> |
| <span class="source-line-no">478</span><span id="line-478"> public abstract ByteBuffer[] nioByteBuffers();</span> |
| <span class="source-line-no">479</span><span id="line-479"></span> |
| <span class="source-line-no">480</span><span id="line-480"> @Override</span> |
| <span class="source-line-no">481</span><span id="line-481"> public String toString() {</span> |
| <span class="source-line-no">482</span><span id="line-482"> return this.getClass().getSimpleName() + "[pos=" + position() + ", lim=" + limit() + ", cap= "</span> |
| <span class="source-line-no">483</span><span id="line-483"> + capacity() + "]";</span> |
| <span class="source-line-no">484</span><span id="line-484"> }</span> |
| <span class="source-line-no">485</span><span id="line-485"></span> |
| <span class="source-line-no">486</span><span id="line-486"> /********************************* ByteBuff wrapper methods ***********************************/</span> |
| <span class="source-line-no">487</span><span id="line-487"></span> |
| <span class="source-line-no">488</span><span id="line-488"> /**</span> |
| <span class="source-line-no">489</span><span id="line-489"> * In theory, the upstream should never construct an ByteBuff by passing an given refCnt, so</span> |
| <span class="source-line-no">490</span><span id="line-490"> * please don't use this public method in other place. Make the method public here because the</span> |
| <span class="source-line-no">491</span><span id="line-491"> * BucketEntry#wrapAsCacheable in hbase-server module will use its own refCnt and ByteBuffers from</span> |
| <span class="source-line-no">492</span><span id="line-492"> * IOEngine to composite an HFileBlock's ByteBuff, we didn't find a better way so keep the public</span> |
| <span class="source-line-no">493</span><span id="line-493"> * way here.</span> |
| <span class="source-line-no">494</span><span id="line-494"> */</span> |
| <span class="source-line-no">495</span><span id="line-495"> public static ByteBuff wrap(ByteBuffer[] buffers, RefCnt refCnt) {</span> |
| <span class="source-line-no">496</span><span id="line-496"> if (buffers == null || buffers.length == 0) {</span> |
| <span class="source-line-no">497</span><span id="line-497"> throw new IllegalArgumentException("buffers shouldn't be null or empty");</span> |
| <span class="source-line-no">498</span><span id="line-498"> }</span> |
| <span class="source-line-no">499</span><span id="line-499"> return buffers.length == 1</span> |
| <span class="source-line-no">500</span><span id="line-500"> ? new SingleByteBuff(refCnt, buffers[0])</span> |
| <span class="source-line-no">501</span><span id="line-501"> : new MultiByteBuff(refCnt, buffers);</span> |
| <span class="source-line-no">502</span><span id="line-502"> }</span> |
| <span class="source-line-no">503</span><span id="line-503"></span> |
| <span class="source-line-no">504</span><span id="line-504"> public static ByteBuff wrap(ByteBuffer[] buffers, Recycler recycler) {</span> |
| <span class="source-line-no">505</span><span id="line-505"> return wrap(buffers, RefCnt.create(recycler));</span> |
| <span class="source-line-no">506</span><span id="line-506"> }</span> |
| <span class="source-line-no">507</span><span id="line-507"></span> |
| <span class="source-line-no">508</span><span id="line-508"> public static ByteBuff wrap(ByteBuffer[] buffers) {</span> |
| <span class="source-line-no">509</span><span id="line-509"> return wrap(buffers, RefCnt.create());</span> |
| <span class="source-line-no">510</span><span id="line-510"> }</span> |
| <span class="source-line-no">511</span><span id="line-511"></span> |
| <span class="source-line-no">512</span><span id="line-512"> public static ByteBuff wrap(List<ByteBuffer> buffers, Recycler recycler) {</span> |
| <span class="source-line-no">513</span><span id="line-513"> return wrap(buffers, RefCnt.create(recycler));</span> |
| <span class="source-line-no">514</span><span id="line-514"> }</span> |
| <span class="source-line-no">515</span><span id="line-515"></span> |
| <span class="source-line-no">516</span><span id="line-516"> public static ByteBuff wrap(List<ByteBuffer> buffers) {</span> |
| <span class="source-line-no">517</span><span id="line-517"> return wrap(buffers, RefCnt.create());</span> |
| <span class="source-line-no">518</span><span id="line-518"> }</span> |
| <span class="source-line-no">519</span><span id="line-519"></span> |
| <span class="source-line-no">520</span><span id="line-520"> public static ByteBuff wrap(ByteBuffer buffer) {</span> |
| <span class="source-line-no">521</span><span id="line-521"> return wrap(buffer, RefCnt.create());</span> |
| <span class="source-line-no">522</span><span id="line-522"> }</span> |
| <span class="source-line-no">523</span><span id="line-523"></span> |
| <span class="source-line-no">524</span><span id="line-524"> /**</span> |
| <span class="source-line-no">525</span><span id="line-525"> * Calling this method in strategic locations where ByteBuffs are referenced may help diagnose</span> |
| <span class="source-line-no">526</span><span id="line-526"> * potential buffer leaks. We pass the buffer itself as a default hint, but one can use</span> |
| <span class="source-line-no">527</span><span id="line-527"> * {@link #touch(Object)} to pass their own hint as well.</span> |
| <span class="source-line-no">528</span><span id="line-528"> */</span> |
| <span class="source-line-no">529</span><span id="line-529"> @Override</span> |
| <span class="source-line-no">530</span><span id="line-530"> public ByteBuff touch() {</span> |
| <span class="source-line-no">531</span><span id="line-531"> return touch(this);</span> |
| <span class="source-line-no">532</span><span id="line-532"> }</span> |
| <span class="source-line-no">533</span><span id="line-533"></span> |
| <span class="source-line-no">534</span><span id="line-534"> @Override</span> |
| <span class="source-line-no">535</span><span id="line-535"> public ByteBuff touch(Object hint) {</span> |
| <span class="source-line-no">536</span><span id="line-536"> refCnt.touch(hint);</span> |
| <span class="source-line-no">537</span><span id="line-537"> return this;</span> |
| <span class="source-line-no">538</span><span id="line-538"> }</span> |
| <span class="source-line-no">539</span><span id="line-539"></span> |
| <span class="source-line-no">540</span><span id="line-540"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">541</span><span id="line-541"> allowedOnPath = ".*/src/test/.*")</span> |
| <span class="source-line-no">542</span><span id="line-542"> public RefCnt getRefCnt() {</span> |
| <span class="source-line-no">543</span><span id="line-543"> return refCnt;</span> |
| <span class="source-line-no">544</span><span id="line-544"> }</span> |
| <span class="source-line-no">545</span><span id="line-545"></span> |
| <span class="source-line-no">546</span><span id="line-546"> // Make this private because we don't want to expose the refCnt related wrap method to upstream.</span> |
| <span class="source-line-no">547</span><span id="line-547"> private static ByteBuff wrap(List<ByteBuffer> buffers, RefCnt refCnt) {</span> |
| <span class="source-line-no">548</span><span id="line-548"> if (buffers == null || buffers.size() == 0) {</span> |
| <span class="source-line-no">549</span><span id="line-549"> throw new IllegalArgumentException("buffers shouldn't be null or empty");</span> |
| <span class="source-line-no">550</span><span id="line-550"> }</span> |
| <span class="source-line-no">551</span><span id="line-551"> return buffers.size() == 1</span> |
| <span class="source-line-no">552</span><span id="line-552"> ? new SingleByteBuff(refCnt, buffers.get(0))</span> |
| <span class="source-line-no">553</span><span id="line-553"> : new MultiByteBuff(refCnt, buffers.toArray(new ByteBuffer[0]));</span> |
| <span class="source-line-no">554</span><span id="line-554"> }</span> |
| <span class="source-line-no">555</span><span id="line-555"></span> |
| <span class="source-line-no">556</span><span id="line-556"> // Make this private because we don't want to expose the refCnt related wrap method to upstream.</span> |
| <span class="source-line-no">557</span><span id="line-557"> private static ByteBuff wrap(ByteBuffer buffer, RefCnt refCnt) {</span> |
| <span class="source-line-no">558</span><span id="line-558"> return new SingleByteBuff(refCnt, buffer);</span> |
| <span class="source-line-no">559</span><span id="line-559"> }</span> |
| <span class="source-line-no">560</span><span id="line-560">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
