CacheFactory.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_CACHEFACTORY_H_
#define GEODE_CACHEFACTORY_H_

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

#include "geode_globals.hpp"
#include "geode_types.hpp"
#include "DistributedSystem.hpp"
#include "Cache.hpp"
#include "CacheAttributes.hpp"
#include "PoolFactory.hpp"
#define DEFAULT_POOL_NAME "default_geodeClientPool"

namespace apache {
namespace geode {
namespace client {

class CppCacheLibrary;
class CPPCACHE_EXPORT CacheFactory : public SharedBase {
 public:
  static CacheFactoryPtr createCacheFactory(
      const PropertiesPtr& dsProps = NULLPTR);

  CachePtr create();

  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();

  CachePtr create(const char* name, DistributedSystemPtr system = NULLPTR,
                  const char* cacheXml = 0,
                  const CacheAttributesPtr& attrs = NULLPTR);

  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 client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CACHEFACTORY_H_