sdbConnectionPoolComm.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 = sdbConnectionPoolComm.hpp

   Descriptive Name = SDB Connection Pool Common Include Header

   When/how to use: this program may be used on sequoiadb connection pool function.

   Dependencies: N/A

   Restrictions: N/A

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

   Last Changed =

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

#ifndef SDB_CONNECTIONPOOL_COMM_HPP_
#define SDB_CONNECTIONPOOL_COMM_HPP_

#include "ossTypes.h"
#include <string>
#include "client.hpp"

using std::string;
namespace sdbclient
{
   #define SDB_CONNPOOL_TOPRECREATE_THRESHOLD                2

   #define SDB_CONNPOOL_CHECKUNNORMALCOORD_INTERVAL          (60 * 1000)

   #define SDB_CONNPOOL_CREATECONN_RETRYTIME                 3

   enum SDB_CONN_STRATEGY
   {
      SDB_CONN_STY_SERIAL,             
      SDB_CONN_STY_RANDOM,             
      SDB_CONN_STY_LOCAL,              
      SDB_CONN_STY_BALANCE             
   } ;

   class DLLEXPORT sdbConnectionPoolConf
   {
   public:
      sdbConnectionPoolConf()
         :_userName(),
         _passwd(),
         _initConnCount(10),
         _deltaIncCount(10),
         _maxIdleCount(20),
         _maxCount(500),
         _checkInterval(60 * 1000),
         _keepAliveTimeout(0 * 1000),
         _syncCoordInterval(0 * 1000),
         _validateConnection(FALSE),
         _connectStrategy(SDB_CONN_STY_SERIAL),
         _useSSL(FALSE) {}

   private:
      // user info
      string               _userName ;
      string               _passwd ;
      string               _cipherFile ;
      string               _token ;
      // connection number info
      INT32                _initConnCount ;
      INT32                _deltaIncCount ;
      INT32                _maxIdleCount ;
      INT32                _maxCount ;
      // check idle connection interval
      INT32                _checkInterval ;
      INT32                _keepAliveTimeout ;
      // sync coord interval
      INT32                _syncCoordInterval ;
      // whether check validation when a connection out
      BOOLEAN              _validateConnection ;
      // strategy to create connections
      SDB_CONN_STRATEGY    _connectStrategy ;

      // if configure is valid
      BOOLEAN              _useSSL ;

   public:
      void setAuthInfo(
         const string &username,
         const string &passwd ) ;

      void setAuthInfo( const string &username,
                        const string &cipherFile,
                        const string &token ) ;

      string getUserName() const { return _userName ; }

      string getPasswd() const { return _passwd ; }

      string getCipherFile() const { return _cipherFile ; }

      string getToken() const { return _token ; }

      void setConnCntInfo(
         INT32 initCnt,
         INT32 deltaIncCnt,
         INT32 maxIdleCnt,
         INT32 maxCnt ) ;

      INT32 getInitConnCount() const { return _initConnCount ; }

      INT32 getDeltaIncCount() const { return _deltaIncCount ; }

      INT32 getMaxIdleCount() const { return _maxIdleCount ; }

      INT32 getMaxCount() const { return _maxCount ; }

      void setCheckIntervalInfo( INT32 interval, INT32 aliveTime = 0 ) ;

      INT32 getCheckInterval() const { return _checkInterval ; }

      INT32 getKeepAliveTimeout() const { return _keepAliveTimeout ; }

      void setSyncCoordInterval ( INT32 interval )
      {
         _syncCoordInterval = interval ;
      }
      INT32 getSyncCoordInterval() const { return _syncCoordInterval ; }

      void setValidateConnection( BOOLEAN bCheck )
      {
         _validateConnection = bCheck ;
      }

      BOOLEAN getValidateConnection() const { return _validateConnection ; }

      void setConnectStrategy( SDB_CONN_STRATEGY strategy )
      {
         _connectStrategy = strategy ;
      }
      SDB_CONN_STRATEGY getConnectStrategy() const
      {
         return _connectStrategy ;
      }

      void setUseSSL( BOOLEAN useSSL )
      {
         _useSSL = useSSL ;
      }
      BOOLEAN getUseSSL() const { return _useSSL ; }


      BOOLEAN isValid() ;

   } ;
}
#endif /* SDB_CONNECTIONPOOL_COMM_HPP_ */