Connection.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2005-2013 (http://safir.sourceforge.net)
*
* Created by: Jörgen Johansson / stjrjo
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core 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 Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef Safir_Databases_Connection_h
#define Safir_Databases_Connection_h

#include "Safir/Databases/Odbc/Defs.h"
#include "Safir/Databases/Odbc/Internal/InternalDefs.h"
#include <Safir/Dob/Typesystem/Defs.h>
#include <vector>
#include <boost/noncopyable.hpp>

namespace Safir
{
namespace Databases
{
namespace Odbc
{
class Environment;
class Statement;

#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4275)
#pragma warning(disable: 4251)
#endif

class OLIB_API Connection : private boost::noncopyable
{
public:
    Connection():
        m_hConnection(SQL_NULL_HDBC),
        m_bIsConnected(false)
    {
        // This bit of code will make sure that the client is using the 
        // same size for SQLWCHAR as the library.
        CheckSQLWCHARSize(sizeof(SQLWCHAR));
    }

    ~Connection();

    void Alloc(const Environment & environment);

    void Free();

    void Connect(const std::wstring & wszConnectionString);

    void Connect(char * cszConnectionString);

    void Disconnect();

    void UseAutoTransactions();

    void UseManualTransactions();

    void Commit();

    void Rollback();

    void SetConnectAttr(long lAttribute, long lValue);

    void SetConnectAttr(long lAttribute, const std::wstring & wszValue);

    void GetConnectAttr(long lAttribute, long & lValue) const;

    void GetConnectAttr(long lAttribute, wchar_t * wszValue, unsigned long ulLength) const;

    bool GetDiagRec(short sRecNumber,
                    std::wstring & SqlState,
                    boost::int32_t & NativeError,
                    std::wstring & MessageText,
                    bool & bDataRead) const;

    bool IsValid() const;

    bool IsConnected() const;

    SQLHDBC Handle() const;
private:
    SQLHDBC m_hConnection;
    bool m_bIsConnected;

    typedef std::pair<std::wstring,std::wstring> StateMessagePair;
    //returns pair of SQLState and MessageText
    const StateMessagePair GetDiagRec() const;

    void AddStatement(Statement * pStatement);
    void RemoveStatement(Statement * pStatement);
    void EndTran(short sCompletionType);
    void ThrowReconnectException(   const std::wstring & fileName,
                                    const Safir::Dob::Typesystem::Int64 lineNumber) const;
    void ThrowReconnectException(   SQLSMALLINT HandleType,
                                    SQLHANDLE Handle,
                                    const std::wstring & fileName,
                                    const Safir::Dob::Typesystem::Int64 lineNumber) const;

    std::vector<Statement *> m_statements;

    friend class Safir::Databases::Odbc::Statement;

    static void CheckSQLWCHARSize(const size_t size);
};

#ifdef _MSC_VER
#pragma warning(pop)
#endif

inline
void Connection::UseAutoTransactions()
{
    SetConnectAttr(SQL_ATTR_AUTOCOMMIT, static_cast<long>(SQL_AUTOCOMMIT_ON));
}

inline
void Connection::UseManualTransactions()
{
    SetConnectAttr(SQL_ATTR_AUTOCOMMIT, static_cast<long>(SQL_AUTOCOMMIT_OFF));
}

inline
void Connection::Commit()
{
    EndTran(SQL_COMMIT);
}

inline
void Connection::Rollback()
{
    EndTran(SQL_ROLLBACK);
}

inline
bool Connection::IsValid() const
{
    return m_hConnection != SQL_NULL_HDBC;
}

inline
bool Connection::IsConnected() const
{
    return m_bIsConnected;
}

inline
SQLHDBC Connection::Handle() const
{
    return m_hConnection;
}

} // End namespace Odbc

} // End namespace Databases

} // End namespace Safir

#endif //Safir_Databases_Connection_h