mongodb/client/connpool.h

/** @file connpool.h */

/*    Copyright 2009 10gen Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include <stack>
#include "dbclient.h"
#include "redef_macros.h"

namespace mongo {

    struct PoolForHost {
        PoolForHost()
            : created(0){}
        std::stack<DBClientBase*> pool;
        long long created;
    };
    
    class DBConnectionHook {
    public:
        virtual ~DBConnectionHook(){}
        virtual void onCreate( DBClientBase * conn ){}
        virtual void onHandedOut( DBClientBase * conn ){}
    };

    /** Database connection pool.

        Generally, use ScopedDbConnection and do not call these directly.

        This class, so far, is suitable for use with unauthenticated connections. 
        Support for authenticated connections requires some adjustements: please 
        request...

        Usage:
        
        {
           ScopedDbConnection c("myserver");
           c.conn()...
        }
    */
    class DBConnectionPool {
        mongo::mutex _mutex;
        map<string,PoolForHost*> _pools; // servername -> pool
        list<DBConnectionHook*> _hooks;
        
        void onCreate( DBClientBase * conn );
        void onHandedOut( DBClientBase * conn );
    public:
        void flush();
        DBClientBase *get(const string& host);
        void release(const string& host, DBClientBase *c) {
            if ( c->isFailed() ){
                delete c;
                return;
            }
            scoped_lock L(_mutex);
            _pools[host]->pool.push(c);
        }
        void addHook( DBConnectionHook * hook );
        void appendInfo( BSONObjBuilder& b );
    };
    
    extern DBConnectionPool pool;

    /** Use to get a connection from the pool.  On exceptions things
       clean up nicely.
    */
    class ScopedDbConnection : boost::noncopyable {
        const string _host;
        DBClientBase *_conn;
    public:
        /** get the associated connection object */
        DBClientBase* operator->(){ 
            uassert( 11004 ,  "did you call done already" , _conn );
            return _conn; 
        }
        
        /** get the associated connection object */
        DBClientBase& conn() {
            uassert( 11005 ,  "did you call done already" , _conn );
            return *_conn;
        }

        /** get the associated connection object */
        DBClientBase* get() {
            uassert( 13102 ,  "did you call done already" , _conn );
            return _conn;
        }
        
        ScopedDbConnection()
            : _host( "" ) , _conn(0) {
        }

        /** throws UserException if can't connect */
        ScopedDbConnection(const string& host)
            : _host(host), _conn( pool.get(host) ) {
        }
        
        ScopedDbConnection(const string& host, DBClientBase* conn )
            : _host( host ) , _conn( conn ){
        }
        
        string getHost() const { return _host; }

        /** Force closure of the connection.  You should call this if you leave it in
            a bad state.  Destructor will do this too, but it is verbose.
        */
        void kill() {
            delete _conn;
            _conn = 0;
        }

        /** Call this when you are done with the connection.
            
            If you do not call done() before this object goes out of scope, 
            we can't be sure we fully read all expected data of a reply on the socket.  so
            we don't try to reuse the connection in that situation.
        */
        void done() {
            if ( ! _conn )
                return;

            /* we could do this, but instead of assume one is using autoreconnect mode on the connection 
            if ( _conn->isFailed() )
                kill();
            else
            */
            pool.release(_host, _conn);
            _conn = 0;
        }
        
        ScopedDbConnection * steal();

        ~ScopedDbConnection();

    };

} // namespace mongo

#include "undef_macros.h"