| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.regionserver.wal;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.fs.Path;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.wal.WALKey;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Get notification of WAL events. The invocations are inline<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * so make sure your implementation is fast else you'll slow hbase.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> */<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public interface WALActionsListener {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /** The reason for the log roll request. */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> static enum RollRequestReason {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> /** The length of the log exceeds the roll size threshold. */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> SIZE,<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /** Too few replicas in the writer pipeline. */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> LOW_REPLICATION,<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /** Too much time spent waiting for sync. */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> SLOW_SYNC,<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /** I/O or other error. */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> ERROR<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> };<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * The WAL is going to be rolled. The oldPath can be null if this is<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * the first log file from the regionserver.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param oldPath the path to the old wal<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param newPath the path to the new wal<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> default void preLogRoll(Path oldPath, Path newPath) throws IOException {}<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * The WAL has been rolled. The oldPath can be null if this is<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * the first log file from the regionserver.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param oldPath the path to the old wal<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param newPath the path to the new wal<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> default void postLogRoll(Path oldPath, Path newPath) throws IOException {}<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * The WAL is going to be archived.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param oldPath the path to the old wal<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param newPath the path to the new wal<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> default void preLogArchive(Path oldPath, Path newPath) throws IOException {}<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * The WAL has been archived.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param oldPath the path to the old wal<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @param newPath the path to the new wal<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> default void postLogArchive(Path oldPath, Path newPath) throws IOException {}<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * A request was made that the WAL be rolled.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> default void logRollRequested(RollRequestReason reason) {}<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * The WAL is about to close.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> default void logCloseRequested() {}<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Called before each write.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> default void visitLogEntryBeforeWrite(RegionInfo info, WALKey logKey, WALEdit logEdit) {}<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param logKey<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param logEdit TODO: Retire this in favor of<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * {@link #visitLogEntryBeforeWrite(RegionInfo, WALKey, WALEdit)} It only exists to get<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * scope when replicating. Scope should be in the WALKey and not need us passing in a<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * <code>htd</code>.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @throws IOException If failed to parse the WALEdit<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> default void visitLogEntryBeforeWrite(WALKey logKey, WALEdit logEdit) throws IOException {}<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /**<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * For notification post append to the writer. Used by metrics system at least.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * TODO: Combine this with above.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param entryLen approx length of cells in this append.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param elapsedTimeMillis elapsed time in milliseconds.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param logKey A WAL key<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param logEdit A WAL edit containing list of cells.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @throws IOException if any network or I/O error occurred<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> default void postAppend(final long entryLen, final long elapsedTimeMillis, final WALKey logKey,<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> final WALEdit logEdit) throws IOException {}<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * For notification post writer sync. Used by metrics system at least.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param timeInNanos How long the filesystem sync took in nanoseconds.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param handlerSyncs How many sync handler calls were released by this call to filesystem<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * sync.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> default void postSync(final long timeInNanos, final int handlerSyncs) {}<a name="line.120"></a> |
| <span class="sourceLineNo">121</span>}<a name="line.121"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
