sdbDataSource.hpp

Go to the documentation of this file.

/*******************************************************************************


   Copyright (C) 2011-2018 SequoiaDB Ltd.

   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.

   Source File Name = sdbDataSource.hpp

   Descriptive Name = SDB Data Source Include Header

   When/how to use: this program may be used on sequoiadb data source function.

   Dependencies: N/A

   Restrictions: N/A

   Change Activity:
   defect Date        Who Description
   ====== =========== === ==============================================
         06/30/2016  LXJ  Initial Draft

   Last Changed =

*******************************************************************************/

#ifndef SDB_DATA_SOURCE_HPP_
#define SDB_DATA_SOURCE_HPP_

#include "sdbDataSourceComm.hpp"
#include <list>

#ifndef SDB_CLIENT
#define SDB_CLIENT
#endif

#include "ossLatch.hpp"
#include "ossMem.hpp"
#include "ossAtomic.hpp"


namespace sdbclient
{
   class sdbDataSourceStrategy ;
   class sdbDSWorker ;
   class DLLEXPORT sdbDataSource : public SDBObject
   {
      friend void createConnFunc( void *args ) ;
      friend void destroyConnFunc( void *args ) ;
      friend void bgTaskFunc( void *args ) ;
      
   public:
      sdbDataSource()
         : _idleList(),
         _idleSize(0),
         _busyList(),
         _busySize(0),
         _destroyList(),
         _conf(),
         _strategy(NULL),
         _connMutex(),
         _globalMutex(),
         _isInited(FALSE),
         _isEnabled(FALSE),
         _toCreateConn(FALSE),
         _toDestroyConn(FALSE),
         _toStopWorkers(FALSE),
         _createConnWorker(NULL),
         _destroyConnWorker(NULL),
         _bgTaskWorker(NULL) {}

      ~sdbDataSource() ;

   private:
      sdbDataSource( const sdbDataSource &datasource ) ;
      sdbDataSource& operator=( const sdbDataSource &datasource ) ;

   public:
      INT32 init( const std::string &url, const sdbDataSourceConf &conf ) ;

      INT32 init( 
         const std::vector<std::string> &vUrls, 
         const sdbDataSourceConf &conf ) ;

      INT32 getIdleConnNum()const  ;

      INT32 getUsedConnNum()const  ;

      INT32 getNormalCoordNum()const  ;

      INT32 getAbnormalCoordNum() const  ;

      INT32 getLocalCoordNum()const  ;

      void addCoord( const string &url ) ;

      void removeCoord( const string &url ) ;

      INT32 enable() ;

      INT32 disable() ;

      INT32 getConnection( sdb*& conn, INT64 timeoutms = 5000 ) ;

      void releaseConnection(sdb *conn) ;

      void close() ;

   
//#if defined (_DEBUG)
//   private:
//      void printCreateInfo(const std::string& coord) ;
//#endif


   private:
      // check address arguments, if valid, add it
      BOOLEAN _checkAddrArg( const string &url ) ;

      // new a strategy with config
      INT32 _buildStrategy() ;

      // clear data source
      void _clearDataSource() ;

      // try to get a connection
      BOOLEAN _tryGetConn( sdb*& conn ) ;

      // create connection by a number
      INT32 _createConnByNum( INT32 num ) ;

      // sync coord node info
      void _syncCoordNodes() ;

      // get back the coord address from the abnormal address list
      INT32 _retrieveAddrFromAbnormalList() ;

      // check keep alive time out or not
      BOOLEAN _keepAliveTimeOut( sdb *conn ) ;

      // check max connection number intervally
      void _checkMaxIdleConn() ;

      // add new connection and make sure not reach max connection count
      BOOLEAN _addNewConnSafely( sdb *conn, const std::string &coord );

   private:
      // create connections function
      void _createConn() ;

      //destroy connections function
      void _destroyConn() ;

      // background task function
      void _bgTask() ;

   private:
      // idle connection list
      std::list<sdb*>         _idleList ;
      ossAtomic32             _idleSize ;
      // busy connection list
      std::list<sdb*>         _busyList ;
      ossAtomic32             _busySize ;
      // to be destroyed connection list
      std::list<sdb*>         _destroyList ;
      // data source confiture
      sdbDataSourceConf       _conf ;
      // data source strategy
      sdbDataSourceStrategy*  _strategy ;
      // lock for connection lists
      ossSpinXLatch           _connMutex ;
      // lock for global commuincate
      ossSpinXLatch           _globalMutex ;
      // if has been inited
      BOOLEAN                 _isInited ;
      // if is enabled
      BOOLEAN                 _isEnabled ;

   private:
      BOOLEAN                 _toCreateConn ;
      BOOLEAN                 _toDestroyConn ;
      BOOLEAN                 _toStopWorkers ;
      sdbDSWorker*            _createConnWorker ;
      sdbDSWorker*            _destroyConnWorker ;
      sdbDSWorker*            _bgTaskWorker ;
   } ;
}

#endif