Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

ConfigurableCacheFactory Class Reference

#include <coherence/net/ConfigurableCacheFactory.hpp>

Inherits XmlConfigurable.

Inherited by DefaultConfigurableCacheFactory [virtual].

List of all members.


Detailed Description

An interface for XML driven cache factory.

See also:
DefaultConfigurableCacheFactory
 

Public Types

typedef spec::Handle Handle
 ConfigurableCacheFactory Handle definition.
typedef spec::View View
 ConfigurableCacheFactory View definition.
typedef spec::Holder Holder
 ConfigurableCacheFactory Holder definition.

Public Member Functions

virtual
NamedCache::Handle 
ensureCache (String::View vsCacheName)=0
 Ensure a cache for the given name using the corresponding XML configuration.
virtual void destroyCache (NamedCache::Handle hCache)=0
 Releases and destroys the specified NamedCache.
virtual void releaseCache (NamedCache::Handle hCache)=0
 Release local resources associated with the specified instance of the cache.
virtual Service::Handle ensureService (String::View vsServiceName)=0
 Ensure a service for the given name using the corresponding XML configuration.
virtual void shutdown ()=0
 Shutdown all services related to this ConfigurableCacheFactory.

Member Function Documentation

virtual NamedCache::Handle ensureCache ( String::View  vsCacheName  )  [pure virtual]

Ensure a cache for the given name using the corresponding XML configuration.

Parameters:
 vsCacheName the cache name
Returns:
a handle to a NamedCache created according to the configuration XML

Implemented in DefaultConfigurableCacheFactory.

virtual void destroyCache ( NamedCache::Handle  hCache  )  [pure virtual]

Releases and destroys the specified NamedCache.

Warning: This method is used to completely destroy the specified cache across the cluster. All references in the entire cluster to this cache will be invalidated, the cached data will be cleared, and all resources will be released.

Parameters:
 hCache the NamedCache object to be destroyed
See also:
releaseCache

Implemented in DefaultConfigurableCacheFactory.

virtual void releaseCache ( NamedCache::Handle  hCache  )  [pure virtual]

Release local resources associated with the specified instance of the cache.

Releasing a NamedCache reference makes it no longer usable, but does not affect the content of the cache. In other words, all other references to the cache will still be valid, and the cache data is not affected by releasing the reference.

The reference that is released using this method can no longer be used; any attempt to use the reference will result in an exception.

Parameters:
 hCache the NamedCache object to be released
See also:
destroyCache

Implemented in DefaultConfigurableCacheFactory.

virtual Service::Handle ensureService ( String::View  vsServiceName  )  [pure virtual]

Ensure a service for the given name using the corresponding XML configuration.

Parameters:
 vsServiceName the service name
Returns:
a handle to a service created according to the configuration XML

Implemented in DefaultConfigurableCacheFactory.


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.