mariadb/ndb/include/ndbapi/ndb_cluster_connection.hpp

/* Copyright (C) 2003 MySQL AB

   This program 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; either version 2 of the License, or
   (at your option) any later version.

   This program 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


#ifndef CLUSTER_CONNECTION_HPP
#define CLUSTER_CONNECTION_HPP

/**
 * @class Ndb_cluster_connection
 * @brief Represents a connection to a cluster of storage nodes
 *
 * Always start your application program by creating a
 * Ndb_cluster_connection object. Your application should contain
 * only one Ndb_cluster_connection.  Your application connects to
 * a cluster management server when method connect() is called.
 * With the method wait_until_ready() it is possible to wait
 * for the connection to one or several storage nodes.
 */
class Ndb_cluster_connection {
public:
  /**
   * Create a connection to a cluster of storage nodes
   *
   * @param specify the connectstring for where to find the
   *        management server
   */
  Ndb_cluster_connection(const char * connect_string = 0);
  ~Ndb_cluster_connection();

  /**
   * Connect to a cluster management server
   *
   * @param no_retries specifies the number of retries to perform
   *        if the connect fails, negative number results in infinite
   *        number of retries
   * @param retry_delay_in_seconds specifies how often retries should
   *        be performed
   * @param verbose specifies if the method should print progess
   *
   * @return 0 if success, 
   *         1 if retriable error,
   *        -1 if non-retriable error
   */
  int connect(int no_retries=0, int retry_delay_in_seconds=1, int verbose=0);

#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
  int start_connect_thread(int (*connect_callback)(void)= 0);
#endif

  /**
   * Wait until one or several storage nodes are connected
   *
   * @param time_out_for_first_alive number of seconds to wait until
   *        first alive node is detected
   * @param timeout_after_first_alive number of seconds to wait after
   *        first alive node is detected
   *
   * @return 0 all nodes alive,
   *         > 0 at least one node alive,
   *         < 0 error
   */
  int wait_until_ready(int timeout_for_first_alive,
		       int timeout_after_first_alive);

#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
  const char *get_connectstring(char *buf, int buf_sz) const;
  int get_connected_port() const;
  const char *get_connected_host() const;

  void set_optimized_node_selection(int val);

  unsigned no_db_nodes();
#endif

private:
  friend class Ndb;
  friend class NdbImpl;
  friend class Ndb_cluster_connection_impl;
  class Ndb_cluster_connection_impl & m_impl;
  Ndb_cluster_connection(Ndb_cluster_connection_impl&);
};

#endif