RegionFactory.hpp

Go to the documentation of this file.

#ifndef __GEMFIRE_REGIONFACTORY_H__
#define __GEMFIRE_REGIONFACTORY_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 "AttributesFactory.hpp"
namespace gemfire {
  class CacheImpl;
class CPPCACHE_EXPORT RegionFactory: public SharedBase{
  public:

 /*
  * To create the (@link Region}.
  * @param name
  *        the name of the Region.
  * @throws RegionExistsException if a region is already in
  * this cache
  * @throws CacheClosedException if the cache is closed
  */
  RegionPtr create(const char* name);
    
  RegionFactoryPtr setCacheLoader(const CacheLoaderPtr& cacheLoader);

  RegionFactoryPtr setCacheWriter(const CacheWriterPtr& cacheWriter);

  RegionFactoryPtr setCacheListener(const CacheListenerPtr& aListener);

  RegionFactoryPtr setPartitionResolver(const PartitionResolverPtr& aResolver);

  RegionFactoryPtr setCacheLoader(const char* libpath, const char* factoryFuncName);

  RegionFactoryPtr setCacheWriter(const char* libpath, const char* factoryFuncName);

  RegionFactoryPtr setCacheListener(const char* libpath, const char* factoryFuncName);

  RegionFactoryPtr setPartitionResolver(const char* libpath, const char* factoryFuncName);

  // EXPIRATION ATTRIBUTES

  RegionFactoryPtr setEntryIdleTimeout(ExpirationAction::Action action, int32_t idleTimeout);

  RegionFactoryPtr setEntryTimeToLive(ExpirationAction::Action action, int32_t timeToLive);


  RegionFactoryPtr setRegionIdleTimeout(ExpirationAction::Action action, int32_t idleTimeout);

  RegionFactoryPtr setRegionTimeToLive(ExpirationAction::Action action, int32_t timeToLive);

  // PERSISTENCE
  RegionFactoryPtr setPersistenceManager(const char* libpath, const char* factoryFuncName,
      const PropertiesPtr& config = NULLPTR);

  RegionFactoryPtr setPersistenceManager(const PersistenceManagerPtr& persistenceManager, 
      const PropertiesPtr& config = NULLPTR);

  // MAP ATTRIBUTES
  RegionFactoryPtr setInitialCapacity( int initialCapacity);

  RegionFactoryPtr setLoadFactor( float loadFactor);

  RegionFactoryPtr setConcurrencyLevel(uint8_t concurrencyLevel);

  RegionFactoryPtr setLruEntriesLimit( const uint32_t entriesLimit );

  RegionFactoryPtr setDiskPolicy(const DiskPolicyType::PolicyType diskPolicy);

   RegionFactoryPtr setCachingEnabled( bool cachingEnabled );

  /*
   * Set the PoolName to attach the Region with that Pool.
   * Use only when Cache ha more than one Pool
   * @param name 
   *        the name of the Pool to which region will be attached. 
   * @return a reference to <code>this</code>
   */
   RegionFactoryPtr setPoolName( const char * name );

  /*
   * Set boolean to enable/disable cloning while applying delta.
   * @param isClonable whether to enable cloning or not.
   * @return a reference to <code>this</code>
   */
   RegionFactoryPtr setCloningEnabled( bool isClonable );
   
   RegionFactoryPtr setConcurrencyChecksEnabled( bool enable );
   
   RegionFactoryPtr setTombstoneTimeout( uint32_t tombstoneTimeoutInMSec);

  private :
    RegionFactory(gemfire::RegionShortcut preDefinedRegion);

    RegionShortcut m_preDefinedRegion;

    AttributesFactoryPtr m_attributeFactory;

    void setRegionShortcut();

  ~RegionFactory();
  friend class CacheImpl;
};
}; //namespace gemfire

#endif //ifndef __GEMFIRE_REGIONFACTORY_H__