Client.h

Go to the documentation of this file.

/*
 * 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_RangeServer_Client_h
#define Hypertable_Lib_RangeServer_Client_h

#include <Common/InetAddr.h>
#include <Common/StaticBuffer.h>
#include <Common/Status.h>

#include <AsyncComm/Comm.h>
#include <AsyncComm/CommBuf.h>
#include <AsyncComm/DispatchHandler.h>

#include <Hypertable/Lib/QualifiedRangeSpec.h>
#include <Hypertable/Lib/RangeServerRecovery/ReceiverPlan.h>
#include <Hypertable/Lib/RangeSpec.h>
#include <Hypertable/Lib/RangeState.h>
#include <Hypertable/Lib/ScanBlock.h>
#include <Hypertable/Lib/ScanSpec.h>
#include <Hypertable/Lib/StatsRangeServer.h>
#include <Hypertable/Lib/SystemVariable.h>
#include <Hypertable/Lib/TableIdentifier.h>

#include <map>
#include <memory>

namespace Hypertable {
namespace Lib {
namespace RangeServer {


  class Client {
  public:

    Client(Comm *comm, int32_t timeout_ms=0);
    ~Client();

    void set_default_timeout(int32_t timeout_ms) {
      m_default_timeout_ms = timeout_ms;
    }
    int32_t default_timeout() const { return m_default_timeout_ms; }

    void compact(const CommAddress &addr, const TableIdentifier &table,
                 const String &row, int32_t flags);

    void compact(const CommAddress &addr, const TableIdentifier &table,
                 const String &row, int32_t flags, DispatchHandler *handler);

    void compact(const CommAddress &addr, const TableIdentifier &table,
                 const String &row, int32_t flags,
                 DispatchHandler *handler, Timer &timer);

    void load_range(const CommAddress &addr, const TableIdentifier &table,
                    const RangeSpec &range_spec, const RangeState &range_state,
                    bool needs_compaction);

    void load_range(const CommAddress &addr, const TableIdentifier &table,
                    const RangeSpec &range_spec,  const RangeState &range_state,
                    bool needs_compaction, Timer &timer);

    void acknowledge_load(const CommAddress &addr,
                          const vector<QualifiedRangeSpec *> &ranges,
                          std::map<QualifiedRangeSpec, int> &response_map);

    void update(const CommAddress &addr, uint64_t cluster_id,
                const TableIdentifier &table, int32_t count,
                StaticBuffer &buffer, int32_t flags,
                DispatchHandler *handler);

    void create_scanner(const CommAddress &addr, const TableIdentifier &table,
                        const RangeSpec &range, const ScanSpec &scan_spec,
                        DispatchHandler *handler);

    void create_scanner(const CommAddress &addr, const TableIdentifier &table,
                        const RangeSpec &range, const ScanSpec &scan_spec,
                        DispatchHandler *handler, Timer &timer);

    void create_scanner(const CommAddress &addr, const TableIdentifier &table,
                        const RangeSpec &range, const ScanSpec &scan_spec,
                        ScanBlock &scan_block);

    void create_scanner(const CommAddress &addr, const TableIdentifier &table,
                        const RangeSpec &range, const ScanSpec &scan_spec,
                        ScanBlock &scan_block, Timer &timer);

    void destroy_scanner(const CommAddress &addr, int32_t scanner_id,
                         DispatchHandler *handler);

    void destroy_scanner(const CommAddress &addr, int32_t scanner_id,
                         DispatchHandler *handler, Timer &timer);

    void destroy_scanner(const CommAddress &addr, int32_t scanner_id);

    void destroy_scanner(const CommAddress &addr, int32_t scanner_id, Timer &timer);

    void fetch_scanblock(const CommAddress &addr, int32_t scanner_id,
                         DispatchHandler *handler);

    void fetch_scanblock(const CommAddress &addr, int32_t scanner_id,
                         DispatchHandler *handler, Timer &timer);

    void fetch_scanblock(const CommAddress &addr, int32_t scanner_id,
                         ScanBlock &scan_block);

    void fetch_scanblock(const CommAddress &addr, int32_t scanner_id,
                         ScanBlock &scan_block, Timer &timer);

    void drop_table(const CommAddress &addr, const TableIdentifier &table,
                    DispatchHandler *handler);

    void drop_table(const CommAddress &addr, const TableIdentifier &table,
                    DispatchHandler *handler, Timer &timer);

    void drop_table(const CommAddress &addr, const TableIdentifier &table);

    void drop_table(const CommAddress &addr,
                    const TableIdentifier &table,
                    Timer &timer);

    void update_schema(const CommAddress &addr,
        const TableIdentifier &table, const String &schema,
        DispatchHandler *handler);

    void update_schema(const CommAddress &addr,
                       const TableIdentifier &table, const String &schema,
                       DispatchHandler *handler, Timer &timer);

    void commit_log_sync(const CommAddress &addr, uint64_t cluster_id,
                         const TableIdentifier &table,
                         DispatchHandler *handler);

    void commit_log_sync(const CommAddress &addr, uint64_t cluster_id,
                         const TableIdentifier &table,
                         DispatchHandler *handler, Timer &timer);

    void status(const CommAddress &addr, Status &status);

    void status(const CommAddress &addr, Status &status, Timer &timer);

    void status(const CommAddress &addr, DispatchHandler *handler,
                Timer &timer);

    void wait_for_maintenance(const CommAddress &addr);

    void shutdown(const CommAddress &addr);

    void dump(const CommAddress &addr, String &outfile, bool nokeys);

    void dump_pseudo_table(const CommAddress &addr, const TableIdentifier &table,
                           const String &pseudo_table_name, const String &outfile);

    void get_statistics(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                        int64_t generation, StatsRangeServer &stats);

    void get_statistics(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                        int64_t generation, StatsRangeServer &stats, Timer &timer);

    void get_statistics(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                        int64_t generation, DispatchHandler *handler);


    void get_statistics(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                        int64_t generation, DispatchHandler *handler, Timer &timer);

    void drop_range(const CommAddress &addr, const TableIdentifier &table,
                    const RangeSpec &range, DispatchHandler *handler);

    void drop_range(const CommAddress &addr, const TableIdentifier &table,
                    const RangeSpec &range, DispatchHandler *handler,
                    Timer &timer);

    void relinquish_range(const CommAddress &addr, const TableIdentifier &table,
                          const RangeSpec &range);

    void relinquish_range(const CommAddress &addr, const TableIdentifier &table,
                          const RangeSpec &range, Timer &timer);

    void heapcheck(const CommAddress &addr, String &outfile);

    void replay_fragments(const CommAddress &addr, int64_t op_id,
                          const String &recover_location, int32_t plan_generation,
                          int32_t type, const vector<int32_t> &fragments,
                          const Lib::RangeServerRecovery::ReceiverPlan &plan,
                          int32_t replay_timeout);

    void phantom_load(const CommAddress &addr, const String &location,
                      int32_t plan_generation,
                      const vector<int32_t> &fragments,
                      const vector<QualifiedRangeSpec> &range_specs,
                      const vector<RangeState> &range_states);

    void phantom_update(const CommAddress &addr, const String &location,
                        int32_t plan_generation, const QualifiedRangeSpec &range,
                        int32_t fragment, StaticBuffer &updates,
                        DispatchHandler *handler);

    void phantom_prepare_ranges(const CommAddress &addr, int64_t op_id,
                                const String &location, int32_t plan_generation,
                                const vector<QualifiedRangeSpec> &ranges,
                                int32_t timeout);

    void phantom_commit_ranges(const CommAddress &addr, int64_t op_id,
                               const String &location, int32_t plan_generation,
                               const vector<QualifiedRangeSpec> &ranges,
                               int32_t timeout);

    void set_state(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                   int64_t generation, DispatchHandler *handler, Timer &timer);

    void table_maintenance_enable(const CommAddress &addr,
                                  const TableIdentifier &table,
                                  DispatchHandler *handler);

    void table_maintenance_disable(const CommAddress &addr,
                                   const TableIdentifier &table,
                                   DispatchHandler *handler);

  private:
    void do_load_range(const CommAddress &addr, const TableIdentifier &table,
                       const RangeSpec &range_spec, const RangeState &range_state,
                       bool needs_compaction, int32_t timeout_ms);
    void do_create_scanner(const CommAddress &addr,
                           const TableIdentifier &table, const RangeSpec &range,
                           const ScanSpec &scan_spec, ScanBlock &scan_block,
                           int32_t timeout_ms);
    void do_destroy_scanner(const CommAddress &addr, int32_t scanner_id,
                            int32_t timeout_ms);
    void do_fetch_scanblock(const CommAddress &addr, int32_t scanner_id,
                            ScanBlock &scan_block, int32_t timeout_ms);
    void do_drop_table(const CommAddress &addr,
                       const TableIdentifier &table,
                       int32_t timeout_ms);
    void do_status(const CommAddress &addr, Status &status, int32_t timeout_ms);
    void do_get_statistics(const CommAddress &addr, std::vector<SystemVariable::Spec> &specs,
                           int64_t generation, StatsRangeServer &stats,
                           int32_t timeout_ms);
    void do_relinquish_range(const CommAddress &addr, const TableIdentifier &table,
                             const RangeSpec &range, int32_t timeout_ms);

    void send_message(const CommAddress &addr, CommBufPtr &cbp,
                      DispatchHandler *handler, int32_t timeout_ms);

    Comm *m_comm;
    int32_t m_default_timeout_ms;
  };

  typedef std::shared_ptr<Client> ClientPtr;


}}}

#endif // Hypertable_Lib_RangeServer_Client_h