scopedconnection.h

Go to the documentation of this file.

/***********************************************************************
 Copyright (c) 2010 by Joel Fielder.  Others may also hold copyrights
 on code in this file.  See the CREDITS.txt file in the top directory
 of the distribution for details.

 This file is part of MySQL++.

 MySQL++ is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.

 MySQL++ 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 Lesser General Public
 License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with MySQL++; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 USA
***********************************************************************/

#if !defined(MYSQLPP_SCOPEDCONNECTION_H)
#define MYSQLPP_SCOPEDCONNECTION_H

#include "common.h"

namespace mysqlpp {

#if !defined(DOXYGEN_IGNORE)
// Make Doxygen ignore this
class MYSQLPP_EXPORT Connection;
class MYSQLPP_EXPORT ConnectionPool;
#endif

class MYSQLPP_EXPORT ScopedConnection
{
public:
        explicit ScopedConnection(ConnectionPool& pool, bool safe = false);

        ~ScopedConnection();

        Connection* operator->() const { return connection_; }

        Connection& operator*() const { return *connection_; }

        operator void*() const { return connection_; }

private:
        // ScopedConnection objects cannot be copied.  We want them to be
        // tightly scoped to their use point, not put in containers or
        // passed around promiscuously.
        ScopedConnection(const ScopedConnection& no_copies);   
        const ScopedConnection& operator=(const ScopedConnection& no_copies);

        ConnectionPool& pool_;
        Connection* const connection_;
};

} // end namespace mysqlpp

#endif // !defined(MYSQLPP_SCOPEDCONNECTION_H)