/usr/include/mongo/client/connpool.h is in mongodb-dev 1:2.4.9-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | /** @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 "mongo/util/background.h"
#include "mongo/client/dbclientinterface.h"
#include "mongo/platform/cstdint.h"
namespace mongo {
class Shard;
class DBConnectionPool;
/**
* not thread safe
* thread safety is handled by DBConnectionPool
*/
class PoolForHost {
public:
PoolForHost()
: _created(0), _minValidCreationTimeMicroSec(0) {}
PoolForHost( const PoolForHost& other ) {
verify(other._pool.size() == 0);
_created = other._created;
_minValidCreationTimeMicroSec = other._minValidCreationTimeMicroSec;
verify( _created == 0 );
}
~PoolForHost();
int numAvailable() const { return (int)_pool.size(); }
void createdOne( DBClientBase * base );
long long numCreated() const { return _created; }
ConnectionString::ConnectionType type() const { verify(_created); return _type; }
/**
* gets a connection or return NULL
*/
DBClientBase * get( DBConnectionPool * pool , double socketTimeout );
// Deletes all connections in the pool
void clear();
void done( DBConnectionPool * pool , DBClientBase * c );
void flush();
void getStaleConnections( vector<DBClientBase*>& stale );
/**
* Sets the lower bound for creation times that can be considered as
* good connections.
*/
void reportBadConnectionAt(uint64_t microSec);
/**
* @return true if the given creation time is considered to be not
* good for use.
*/
bool isBadSocketCreationTime(uint64_t microSec);
/**
* Sets the host name to a new one, only if it is currently empty.
*/
void initializeHostName(const std::string& hostName);
static void setMaxPerHost( unsigned max ) { _maxPerHost = max; }
static unsigned getMaxPerHost() { return _maxPerHost; }
private:
struct StoredConnection {
StoredConnection( DBClientBase * c );
bool ok( time_t now );
DBClientBase* conn;
time_t when;
};
std::string _hostName;
std::stack<StoredConnection> _pool;
int64_t _created;
uint64_t _minValidCreationTimeMicroSec;
ConnectionString::ConnectionType _type;
static unsigned _maxPerHost;
};
class DBConnectionHook {
public:
virtual ~DBConnectionHook() {}
virtual void onCreate( DBClientBase * conn ) {}
virtual void onHandedOut( DBClientBase * conn ) {}
virtual void onDestroy( 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 adjustments: please
request...
Usage:
{
ScopedDbConnection c("myserver");
c.conn()...
}
*/
class DBConnectionPool : public PeriodicTask {
public:
DBConnectionPool();
~DBConnectionPool();
/** right now just controls some asserts. defaults to "dbconnectionpool" */
void setName( const string& name ) { _name = name; }
void onCreate( DBClientBase * conn );
void onHandedOut( DBClientBase * conn );
void onDestroy( DBClientBase * conn );
void flush();
DBClientBase *get(const string& host, double socketTimeout = 0);
DBClientBase *get(const ConnectionString& host, double socketTimeout = 0);
void release(const string& host, DBClientBase *c);
void addHook( DBConnectionHook * hook ); // we take ownership
void appendInfo( BSONObjBuilder& b );
/**
* Clears all connections for all host.
*/
void clear();
/**
* Checks whether the connection for a given host is black listed or not.
*
* @param hostName the name of the host the connection connects to.
* @param conn the connection to check.
*
* @return true if the connection is not bad, meaning, it is good to keep it for
* future use.
*/
bool isConnectionGood(const string& host, DBClientBase* conn);
// Removes and deletes all connections from the pool for the host (regardless of timeout)
void removeHost( const string& host );
/** compares server namees, but is smart about replica set names */
struct serverNameCompare {
bool operator()( const string& a , const string& b ) const;
};
virtual string taskName() const { return "DBConnectionPool-cleaner"; }
virtual void taskDoWork();
private:
DBConnectionPool( DBConnectionPool& p );
DBClientBase* _get( const string& ident , double socketTimeout );
DBClientBase* _finishCreate( const string& ident , double socketTimeout, DBClientBase* conn );
struct PoolKey {
PoolKey( const std::string& i , double t ) : ident( i ) , timeout( t ) {}
string ident;
double timeout;
};
struct poolKeyCompare {
bool operator()( const PoolKey& a , const PoolKey& b ) const;
};
typedef map<PoolKey,PoolForHost,poolKeyCompare> PoolMap; // servername -> pool
mongo::mutex _mutex;
string _name;
PoolMap _pools;
// pointers owned by me, right now they leak on shutdown
// _hooks itself also leaks because it creates a shutdown race condition
list<DBConnectionHook*> * _hooks;
};
extern DBConnectionPool pool;
class AScopedConnection : boost::noncopyable {
public:
AScopedConnection() { _numConnections++; }
virtual ~AScopedConnection() { _numConnections--; }
virtual DBClientBase* get() = 0;
virtual void done() = 0;
virtual string getHost() const = 0;
/**
* @return true iff this has a connection to the db
*/
virtual bool ok() const = 0;
/**
* @return total number of current instances of AScopedConnection
*/
static int getNumConnections() { return _numConnections; }
private:
static AtomicUInt _numConnections;
};
/** Use to get a connection from the pool. On exceptions things
clean up nicely (i.e. the socket gets closed automatically when the
scopeddbconnection goes out of scope).
*/
class ScopedDbConnection : public AScopedConnection {
private:
/** the main constructor you want to use
throws UserException if can't connect
*/
explicit ScopedDbConnection(const string& host, double socketTimeout = 0) : _host(host), _conn( pool.get(host, socketTimeout) ), _socketTimeout( socketTimeout ) {
_setSocketTimeout();
}
explicit ScopedDbConnection(const ConnectionString& host, double socketTimeout = 0) : _host(host.toString()), _conn( pool.get(host, socketTimeout) ), _socketTimeout( socketTimeout ) {
_setSocketTimeout();
}
ScopedDbConnection() : _host( "" ) , _conn(0), _socketTimeout( 0 ) {}
/* @param conn - bind to an existing connection */
ScopedDbConnection(const string& host, DBClientBase* conn, double socketTimeout = 0 ) : _host( host ) , _conn( conn ), _socketTimeout( socketTimeout ) {
_setSocketTimeout();
}
public:
// Factory functions for getting ScopedDbConnections. The caller owns the resulting object
// and is responsible for deleting it when finished. This should be used when running a
// command on a shard from the mongos and the command should run with the client's
// authentication. If the command should be run with full permissions regardless
// of whether or not the user is authorized, then use getInternalScopedDbConnection().
static ScopedDbConnection* getScopedDbConnection(const string& host,
double socketTimeout = 0);
static ScopedDbConnection* getScopedDbConnection(const ConnectionString& host,
double socketTimeout = 0);
static ScopedDbConnection* getScopedDbConnection();
// DEPRECATED. This is now just a synonym for getScopedDbConnection.
static ScopedDbConnection* getInternalScopedDbConnection(const string& host,
double socketTimeout = 0);
static ScopedDbConnection* getInternalScopedDbConnection(const ConnectionString& host,
double socketTimeout = 0);
static ScopedDbConnection* getInternalScopedDbConnection();
static void clearPool();
~ScopedDbConnection();
/** get the associated connection object */
DBClientBase* operator->() {
uassert( 11004 , "connection was returned to the pool already" , _conn );
return _conn;
}
/** get the associated connection object */
DBClientBase& conn() {
uassert( 11005 , "connection was returned to the pool already" , _conn );
return *_conn;
}
/** get the associated connection object */
DBClientBase* get() {
uassert( 13102 , "connection was returned to the pool already" , _conn );
return _conn;
}
bool ok() const { return _conn > 0; }
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;
}
private:
void _setSocketTimeout();
const string _host;
DBClientBase *_conn;
const double _socketTimeout;
};
} // namespace mongo
|