hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/Shipper.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.hbase.regionserver;
  19
  20 import java.io.IOException;
  21
  22 import org.apache.yetus.audience.InterfaceAudience;
  23
  24 /**
  25  * This interface denotes a scanner as one which can ship cells. Scan operation do many RPC requests
  26  * to server and fetch N rows/RPC. These are then shipped to client. At the end of every such batch
  27  * {@link #shipped()} will get called.
  28  */
  29 @InterfaceAudience.Private
  30 public interface Shipper {
  31
  32   /**
  33    * Called after a batch of rows scanned and set to be returned to client. Any in between cleanup
  34    * can be done here.
  35    */
  36   void shipped() throws IOException;
  37 }