EditLogOutputStream.java
上传用户:quxuerui
上传日期:2018-01-08
资源大小:41811k
文件大小:3k
源码类别:

网格计算

开发平台:

Java

  1. /**
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *     http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing, software
  13.  * distributed under the License is distributed on an "AS IS" BASIS,
  14.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15.  * See the License for the specific language governing permissions and
  16.  * limitations under the License.
  17.  */
  18. package org.apache.hadoop.hdfs.server.namenode;
  19. import java.io.IOException;
  20. import java.io.OutputStream;
  21. import org.apache.hadoop.io.Writable;
  22. /**
  23.  * A generic abstract class to support journaling of edits logs into 
  24.  * a persistent storage.
  25.  */
  26. abstract class EditLogOutputStream extends OutputStream {
  27.   // these are statistics counters
  28.   private long numSync;        // number of sync(s) to disk
  29.   private long totalTimeSync;  // total time to sync
  30.   EditLogOutputStream() throws IOException {
  31.     numSync = totalTimeSync = 0;
  32.   }
  33.   /**
  34.    * Get this stream name.
  35.    * 
  36.    * @return name of the stream
  37.    */
  38.   abstract String getName();
  39.   /** {@inheritDoc} */
  40.   abstract public void write(int b) throws IOException;
  41.   /**
  42.    * Write edits log record into the stream.
  43.    * The record is represented by operation name and
  44.    * an array of Writable arguments.
  45.    * 
  46.    * @param op operation
  47.    * @param writables array of Writable arguments
  48.    * @throws IOException
  49.    */
  50.   abstract void write(byte op, Writable ... writables) throws IOException;
  51.   /**
  52.    * Create and initialize new edits log storage.
  53.    * 
  54.    * @throws IOException
  55.    */
  56.   abstract void create() throws IOException;
  57.   /** {@inheritDoc} */
  58.   abstract public void close() throws IOException;
  59.   /**
  60.    * All data that has been written to the stream so far will be flushed.
  61.    * New data can be still written to the stream while flushing is performed.
  62.    */
  63.   abstract void setReadyToFlush() throws IOException;
  64.   /**
  65.    * Flush and sync all data that is ready to be flush 
  66.    * {@link #setReadyToFlush()} into underlying persistent store.
  67.    * @throws IOException
  68.    */
  69.   abstract protected void flushAndSync() throws IOException;
  70.   /**
  71.    * Flush data to persistent store.
  72.    * Collect sync metrics.
  73.    */
  74.   public void flush() throws IOException {
  75.     numSync++;
  76.     long start = FSNamesystem.now();
  77.     flushAndSync();
  78.     long end = FSNamesystem.now();
  79.     totalTimeSync += (end - start);
  80.   }
  81.   /**
  82.    * Return the size of the current edits log.
  83.    * Length is used to check when it is large enough to start a checkpoint.
  84.    */
  85.   abstract long length() throws IOException;
  86.   /**
  87.    * Return total time spent in {@link #flushAndSync()}
  88.    */
  89.   long getTotalSyncTime() {
  90.     return totalTimeSync;
  91.   }
  92.   /**
  93.    * Return number of calls to {@link #flushAndSync()}
  94.    */
  95.   long getNumSync() {
  96.     return numSync;
  97.   }
  98. }