CacheFactory.hpp

Go to the documentation of this file.

#ifndef __GEMFIRE_CACHEFACTORY_H__
#define __GEMFIRE_CACHEFACTORY_H__
/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *========================================================================
 */

#include "gfcpp_globals.hpp"
#include "gf_types.hpp"
#include "DistributedSystem.hpp"
#include "Cache.hpp"
#include "CacheAttributes.hpp"
#include "PoolFactory.hpp"
#define DEFAULT_POOL_NAME "default_gemfireClientPool"

namespace gemfire {

class CppCacheLibrary;
class CPPCACHE_EXPORT CacheFactory: public SharedBase{
  public:

  static CacheFactoryPtr createCacheFactory(const PropertiesPtr& dsProps = NULLPTR);
    
  CachePtr create();

   static CachePtr create(const char *name, DistributedSystemPtr& system,
       const char* cacheXml = 0, const CacheAttributesPtr& attrs = NULLPTR, bool ignorePdxUnreadFields = false, bool readPdxSerialized = false);

   static CachePtr create( const char* name, DistributedSystemPtr& system,
       const CacheAttributesPtr& attrs);

   static CachePtr getInstance(const DistributedSystemPtr& system);

   static CachePtr getInstanceCloseOk(const DistributedSystemPtr& system );


   static CachePtr getAnyInstance();

  static const char* getVersion();

  static const char* getProductDescription();

  CacheFactoryPtr setFreeConnectionTimeout(int connectionTimeout);
  CacheFactoryPtr setLoadConditioningInterval(int loadConditioningInterval);
  CacheFactoryPtr setSocketBufferSize(int bufferSize);

  CacheFactoryPtr setThreadLocalConnections(bool threadLocalConnections);

  CacheFactoryPtr setReadTimeout(int timeout);

  CacheFactoryPtr setMinConnections(int minConnections);

  CacheFactoryPtr setMaxConnections(int maxConnections);

  CacheFactoryPtr setIdleTimeout(long idleTimeout);

  CacheFactoryPtr setRetryAttempts(int retryAttempts);

  CacheFactoryPtr setPingInterval(long pingInterval);

  CacheFactoryPtr setUpdateLocatorListInterval(long updateLocatorListInterval);

  CacheFactoryPtr setStatisticInterval(int statisticInterval);

  CacheFactoryPtr setServerGroup(const char* group);

  CacheFactoryPtr addLocator(const char* host, int port);

  CacheFactoryPtr addServer(const char* host, int port);

  CacheFactoryPtr setSubscriptionEnabled(bool enabled);
  CacheFactoryPtr setSubscriptionRedundancy(int redundancy);
  CacheFactoryPtr setSubscriptionMessageTrackingTimeout(int messageTrackingTimeout);

  CacheFactoryPtr setSubscriptionAckInterval(int ackInterval);


  CacheFactoryPtr setMultiuserAuthentication(bool multiuserAuthentication);

   CacheFactoryPtr setPRSingleHopEnabled(bool enabled);

   CacheFactoryPtr setPdxIgnoreUnreadFields(bool ignore);

   CacheFactoryPtr setPdxReadSerialized(bool pdxReadSerialized);

   CacheFactoryPtr set(const char* name, const char* value);    

   private :

    PoolFactoryPtr pf; 
    PropertiesPtr dsProp;
    bool ignorePdxUnreadFields;
    bool pdxReadSerialized;

    PoolFactoryPtr getPoolFactory();

  static void create_(const char* name, DistributedSystemPtr& system, const char* id_data, CachePtr& cptr, bool ignorePdxUnreadFields, bool readPdxSerialized);

  // no instances allowed
  CacheFactory();
  CacheFactory(const PropertiesPtr dsProps);
  ~CacheFactory();

  PoolPtr determineDefaultPool(CachePtr cachePtr);

  static CachePtr getAnyInstance(bool throwException);
  static GfErrType basicGetInstance(const DistributedSystemPtr& system,
      bool closeOk, CachePtr& cptr);

  //Set very first time some creates cache
  static CacheFactoryPtr default_CacheFactory;   
  static PoolPtr createOrGetDefaultPool();
  static void* m_cacheMap;
  static void init();
  static void cleanup();
  static void handleXML( CachePtr& cachePtr, const char* cachexml, DistributedSystemPtr& system );
  friend class CppCacheLibrary;
  friend class RegionFactory;
  friend class RegionXmlCreation;
  friend class CacheXmlCreation;
};
}; //namespace gemfire

#endif //ifndef __GEMFIRE_CACHEFACTORY_H__