QCassandra.h.in

Go to the documentation of this file.

/*
 * Header:
 *      QCassandra.h
 *
 * Description:
 *      Handling of the cassandra::CassandraClient and corresponding transports,
 *      protocols, sockets, etc.
 *
 * Documentation:
 *      See the corresponding .cpp file.
 *
 * License:
 *      Copyright (c) 2011 Made to Order Software Corp.
 * 
 *      http://snapwebsites.org/
 *      contact@m2osw.com
 * 
 *      Permission is hereby granted, free of charge, to any person obtaining a
 *      copy of this software and associated documentation files (the
 *      "Software"), to deal in the Software without restriction, including
 *      without limitation the rights to use, copy, modify, merge, publish,
 *      distribute, sublicense, and/or sell copies of the Software, and to
 *      permit persons to whom the Software is furnished to do so, subject to
 *      the following conditions:
 *
 *      The above copyright notice and this permission notice shall be included
 *      in all copies or substantial portions of the Software.
 *
 *      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *      OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *      MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *      IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *      CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *      TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 *      SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef QCASSANDRA_H
#define QCASSANDRA_H

#include "QtCassandra/QCassandraContext.h"

namespace QtCassandra
{

// that needs to go in something like the QCassandra.h file instead?
static const int   QT_CASSANDRA_LIBRARY_VERSION_MAJOR  = @LIBQTCASSANDRA_VERSION_MAJOR@;
static const int   QT_CASSANDRA_LIBRARY_VERSION_MINOR  = @LIBQTCASSANDRA_VERSION_MINOR@;
static const int   QT_CASSANDRA_LIBRARY_VERSION_PATCH  = @LIBQTCASSANDRA_VERSION_PATCH@;
static const char *QT_CASSANDRA_LIBRARY_VERSION_STRING = "@LIBQTCASSANDRA_VERSION_MAJOR@.@LIBQTCASSANDRA_VERSION_MINOR@.@LIBQTCASSANDRA_VERSION_PATCH@";

class QCassandraPrivate;


// Handling of the transport and CassandraClient objects
class QCassandra : public QObject
{
public:
    QCassandra();
    virtual ~QCassandra();

    static int versionMajor();
    static int versionMinor();
    static int versionPatch();
    static const char *version();

    // connection functions
    bool connect(const QString& host = "localhost", int port = 9160);
    void disconnect();
    bool isConnected() const;
    const QString& clusterName() const;
    const QString& protocolVersion() const;

    // context functions (the database [Cassandra keyspace])
    QSharedPointer<QCassandraContext> context(const QString& context_name);
    const QCassandraContexts& contexts() const;

    QSharedPointer<QCassandraContext> findContext(const QString& context_name) const;
    QCassandraContext& operator[] (const QString& context_name);
    const QCassandraContext& operator[] (const QString& context_name) const;

    void dropContext(const QString& context_name);

    // default consistency level
    consistency_level_t defaultConsistencyLevel() const;
    void setDefaultConsistencyLevel(consistency_level_t default_consistency_level);

    // time stamp helper
    static int64_t timeofday();

private:
    //QSharedPointer<QCassandraContext> currentContext() const;
    void setCurrentContext(QSharedPointer<QCassandraContext> c);
    void clearCurrentContextIf(const QCassandraContext& c);
    QCassandraPrivate *getPrivate();

    friend class QCassandraPrivate;
    friend class QCassandraContext;

    std::auto_ptr<QCassandraPrivate>        f_private;
    QSharedPointer<QCassandraContext>       f_current_context;
    mutable controlled_vars::zbool_t        f_contexts_read;
    QCassandraContexts                      f_contexts;
    QString                                 f_cluster_name;
    QString                                 f_protocol_version;
    consistency_level_t                     f_default_consistency_level;
};

} // namespace QtCassandra
#endif
//#ifndef QCASSANDRA_H
// vim: ts=4 sw=4 et