001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver;
019
020import java.io.IOException;
021import org.apache.hadoop.hbase.HBaseInterfaceAudience;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * This interface denotes a scanner as one which can ship cells. Scan operation do many RPC requests
026 * to server and fetch N rows/RPC. These are then shipped to client. At the end of every such batch
027 * {@link #shipped()} will get called.
028 */
029@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
030public interface Shipper {
031
032  /**
033   * Called after a batch of rows scanned and set to be returned to client. Any in between cleanup
034   * can be done here.
035   */
036  void shipped() throws IOException;
037}