ScanBlock.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 3 of the
 * License, or any later version.
 *
 * Hypertable is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */


#ifndef Hypertable_Lib_ScanBlock_h
#define Hypertable_Lib_ScanBlock_h

#include <Hypertable/Lib/RangeServer/Response/Parameters/CreateScanner.h>
#include <Hypertable/Lib/SerializedKey.h>

#include <AsyncComm/Event.h>

#include <Common/ByteString.h>

#include <memory>
#include <vector>

namespace Hypertable {


  class ScanBlock {
  public:

    typedef std::vector< std::pair<SerializedKey, ByteString> > Vector;

    ScanBlock();

    int load(EventPtr &event);

    size_t size() { return m_vec.size(); }

    void reset() { m_iter = m_vec.begin(); }

    bool next(SerializedKey &key, ByteString &value);

    bool eos() { return !m_response.more(); }

    bool more() {
      if (m_iter == m_vec.end())
        return false;
      return true;
    }

    size_t memory_used() const {
      if (m_event)
        return m_event->payload_len;
      return 0;
    }

    int get_scanner_id() { return m_response.id(); }

    int get_skipped_rows() { return m_response.skipped_rows(); }

    int get_skipped_cells() { return m_response.skipped_cells(); }

    const ProfileDataScanner &profile_data() { return m_response.profile_data(); }

  private:
    int m_error {};
    Vector m_vec;
    Vector::iterator m_iter;
    EventPtr m_event;
    Lib::RangeServer::Response::Parameters::CreateScanner m_response;
  };

  typedef std::shared_ptr<ScanBlock> ScanBlockPtr;

}

#endif // Hypertable_Lib_ScanBlock_h