Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

IUniConfGen Class Reference

#include <uniconfgen.h>

Inheritance diagram for IUniConfGen:

Inheritance graph
[legend]
List of all members.

Detailed Description

An abstract data container that backs a UniConf tree.

This is intended to be implemented to provide support for fetching and storing keys and values using different access methods.


Public Member Functions

virtual void setcallback (const UniConfGenCallback &callback, void *userdata)=0
 Sets the callback for change notification.
virtual bool isok ()=0
 Determines if the generator is usable and working properly.
virtual void commit ()=0
 Commits any changes.
virtual bool refresh ()=0
 Refreshes information about a key recursively.
virtual void flush_buffers ()=0
 Flushes any commitment/notification buffers .
virtual void prefetch (const UniConfKey &key, bool recursive)=0
 Indicate that we will eventually be interested in doing get(), haschildren(), or other "get-like" operations on a particular key or tree of keys.
virtual WvString get (const UniConfKey &key)=0
 Fetches a string value for a key from the registry.
virtual bool exists (const UniConfKey &key)=0
 Without fetching its value, returns true if a key exists.
virtual int str2int (WvStringParm s, int defvalue) const =0
 Converts a string to an integer.
virtual void set (const UniConfKey &key, WvStringParm value)=0
 Stores a string value for a key into the registry.
virtual bool haschildren (const UniConfKey &key)=0
 Returns true if a key has children.
virtual Iter * iterator (const UniConfKey &key)=0
 Returns an iterator over the children of the specified key.
virtual Iter * recursiveiterator (const UniConfKey &key)=0
 Like iterator(), but the returned iterator is recursive, that is, it will return children of the immediate children, not just the immediate children themselves.
virtual unsigned int addRef ()=0
 Indicate you are using this object.
virtual unsigned int release ()=0
 Indicate that you are finished using this object.
virtual IObjectgetInterface (const UUID &)=0
 Returns the requested XPLC interface.
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.


Member Function Documentation

virtual bool IUniConfGen::isok  )  [pure virtual]
 

Determines if the generator is usable and working properly.

The default implementation always returns true.

Implemented in UniCacheGen, UniClientGen, UniConfGen, UniFilterGen, UniPStoreGen, UniRegistryGen, UniReplicateGen, UniRetryGen, and UniUnwrapGen.

virtual void IUniConfGen::commit  )  [pure virtual]
 

Commits any changes.

The default implementation does nothing.

Implemented in UniCacheGen, UniClientGen, UniConfGen, UniFilterGen, UniIniGen, UniMountGen, UniMountTreeGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniSlowGen, and UniUnwrapGen.

virtual bool IUniConfGen::refresh  )  [pure virtual]
 

Refreshes information about a key recursively.

May discard uncommitted data.

The default implementation always returns true.

Implemented in UniCacheGen, UniClientGen, UniConfGen, UniFilterGen, UniIniGen, UniMountGen, UniMountTreeGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniSlowGen, and UniUnwrapGen.

virtual void IUniConfGen::flush_buffers  )  [pure virtual]
 

Flushes any commitment/notification buffers .

The default implementation always returns true. NOTE: This method should be 'protected'

Implemented in UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniNullGen, UniPermGen, UniReadOnlyGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniSlowGen, UniTempGen, and UniUnwrapGen.

virtual void IUniConfGen::prefetch const UniConfKey key,
bool  recursive
[pure virtual]
 

Indicate that we will eventually be interested in doing get(), haschildren(), or other "get-like" operations on a particular key or tree of keys.

The generator may be able to speed up these operations by, say, caching them in advance.

This function is not allowed to do blocking operations. It is allowed to do nothing at all, however, and then get() might block later.

Implemented in UniConfGen, UniFilterGen, UniRetryGen, and UniUnwrapGen.

virtual WvString IUniConfGen::get const UniConfKey key  )  [pure virtual]
 

Fetches a string value for a key from the registry.

If the key doesn't exist, the return value has .isnull() == true.

Implemented in UniCacheGen, UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniSlowGen, UniTempGen, and UniUnwrapGen.

virtual bool IUniConfGen::exists const UniConfKey key  )  [pure virtual]
 

Without fetching its value, returns true if a key exists.

This is provided because it is often more efficient to test existance than to actually retrieve the value.

The default implementation returns !get(key).isnull().

Implemented in UniConfGen, UniFilterGen, UniMountGen, UniMountTreeGen, UniPStoreGen, UniRegistryGen, UniRetryGen, UniSecureGen, UniSlowGen, UniTempGen, and UniUnwrapGen.

virtual int IUniConfGen::str2int WvStringParm  s,
int  defvalue
const [pure virtual]
 

Converts a string to an integer.

If the string is null or not recognized, return defvalue.

This is here to support the common str2int(get(key)).

The default implementation recognizes the booleans 'true', 'yes', 'on' and 'enabled' as 1, and 'false', 'no', 'off' and 'disabled' as 0.

Implemented in UniConfGen.

virtual void IUniConfGen::set const UniConfKey key,
WvStringParm  value
[pure virtual]
 

Stores a string value for a key into the registry.

If the value is WvString::null, the key is deleted.

Returns true on success.

Implemented in UniCacheGen, UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniReadOnlyGen, UniRegistryGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniTempGen, and UniUnwrapGen.

virtual bool IUniConfGen::haschildren const UniConfKey key  )  [pure virtual]
 

Returns true if a key has children.

This is provided because it is often more efficient to test existance than to actually retrieve the keys.

The default implementation uses the iterator returned by iterator() to test whether the child has any keys. Subclasses are strongly encouraged to provide a better implementation.

Implemented in UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniRetryGen, UniSecureGen, UniSlowGen, UniTempGen, and UniUnwrapGen.

virtual Iter* IUniConfGen::iterator const UniConfKey key  )  [pure virtual]
 

Returns an iterator over the children of the specified key.

May return NULL or an empty iterator if the key has no children.

The caller takes ownership of the returned iterator and is responsible for deleting it when finished.

Implemented in UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniReplicateGen, UniRetryGen, UniSecureGen, UniSlowGen, UniTempGen, and UniUnwrapGen.

virtual Iter* IUniConfGen::recursiveiterator const UniConfKey key  )  [pure virtual]
 

Like iterator(), but the returned iterator is recursive, that is, it will return children of the immediate children, not just the immediate children themselves.

May return NULL if the key has no immediate children (since that means there are also no indirect children).

Note that UniConfGen::recursiveiterator() is a default implementation that just calls iterator() recursively, so it'll work in any derived class without you overriding this function. However, you might want to do it anyway if it would be more efficient in your particular case.

Implemented in UniClientGen, UniConfGen, UniFilterGen, UniMountGen, UniRetryGen, UniSecureGen, UniSlowGen, and UniUnwrapGen.

virtual unsigned int IObject::addRef  )  [pure virtual, inherited]
 

Indicate you are using this object.

This increases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

This called a "strong reference", because they will prevent the object from being destroyed. They should thus be used carefully, as they control the lifetime of the object. For example, you do not need to call addRef() on object passed as parameters, unless you intend on keeping them.

addRef() is often called automatically for you in XPLC, but you'll have to call release() by hand sometimes unless you use xplc_ptr.

virtual unsigned int IObject::release  )  [pure virtual, inherited]
 

Indicate that you are finished using this object.

This decreases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

You will usually need to manually release() any object given to you by any other XPLC function, unless you give the object to someone else who will call release.

If you use xplc_ptr, it will do this for you.

virtual IObject* IObject::getInterface const UUID  )  [pure virtual, inherited]
 

Returns the requested XPLC interface.

Will return NULL if the interface is not supported. The returned interface has been addRef()ed, so you will need to release() it when done. Note that the interface returned may be a pointer to the same object or a different one - that's none of your business. Asking for the IObject interface should always return the same pointer for a given logical object, so this can be used for comparison by identity.

You should probably use the convenient mutate() and get() functions instead of this, or use an xplc_ptr, which mutates the object for you.

virtual IWeakRef* IObject::getWeakRef  )  [pure virtual, inherited]
 

Return a weak reference to this object.

A weak reference points at the object, but does not control the lifetime of the object. An object can thus still be deleted while someone holds a weak reference. You will still need to release() the weak reference when you are done with it.

See also:
IWeakRef


The documentation for this class was generated from the following files:
Generated on Sun Jul 10 15:35:43 2005 for WvStreams by  doxygen 1.4.0