Client.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_Client_h
#define Hypertable_Lib_Client_h

#include "Master/Client.h"
#include "NameIdMapper.h"
#include "Namespace.h"
#include "NamespaceCache.h"
#include "TableCache.h"

#include <Hyperspace/Session.h>

#include <AsyncComm/ApplicationQueueInterface.h>
#include <AsyncComm/ConnectionManager.h>

#include <Common/String.h>

#include <memory>

namespace Hypertable {

  class Comm;
  class HqlInterpreter;

  class Client {
  public:

    Client(const std::string &install_dir, const std::string &config_file,
           uint32_t default_timeout_ms=0);

    Client(const std::string &install_dir = String(), uint32_t default_timeout_ms=0);
    ~Client() {}

    void create_namespace(const std::string &name, Namespace *base=NULL,
                          bool create_intermediate=false,
                          bool if_not_exists=false);

    NamespacePtr open_namespace(const std::string &name, Namespace *base=NULL);

    bool exists_namespace(const std::string &name, Namespace *base=NULL);

    void drop_namespace(const std::string &name, Namespace *base=NULL, bool if_exists=false);

    Hyperspace::SessionPtr& get_hyperspace_session();

    Lib::Master::ClientPtr get_master_client();

    NameIdMapperPtr get_nameid_mapper();

    void close();
    void shutdown();

    HqlInterpreter *create_hql_interpreter(bool immutable_namespace=true);

  private:

    void initialize();

    PropertiesPtr           m_props;
    Comm                   *m_comm;
    ConnectionManagerPtr    m_conn_manager;
    ApplicationQueueInterfacePtr m_app_queue;
    Hyperspace::SessionPtr  m_hyperspace;
    NameIdMapperPtr         m_namemap;
    Lib::Master::ClientPtr m_master_client;
    RangeLocatorPtr         m_range_locator;
    uint32_t                m_timeout_ms;
    std::string                  m_install_dir;
    TableCachePtr           m_table_cache;
    NamespaceCachePtr       m_namespace_cache;
    bool                    m_hyperspace_reconnect;
    std::string                  m_toplevel_dir;
  };

  typedef std::shared_ptr<Client> ClientPtr;

}

#endif // Hypertable_Lib_Client_h