WvStreams
|
Communicates with a UniConfDaemon to fetch and store keys and values. More...
#include <uniclientgen.h>
Public Types | |
typedef ::UniListIter | ListIter |
An iterator over a constant list of keys (see below) | |
Public Member Functions | |
UniClientGen (IWvStream *stream, WvStringParm dst=WvString::null) | |
Creates a generator which can communicate with a daemon using the specified stream. More... | |
time_t | set_timeout (time_t _timeout) |
virtual bool | isok () |
Determines if the generator is usable and working properly. More... | |
virtual bool | refresh () |
Refreshes information about a key recursively. More... | |
virtual void | flush_buffers () |
Flushes any commitment/notification buffers . More... | |
virtual void | commit () |
Commits any changes. More... | |
virtual WvString | get (const UniConfKey &key) |
Fetches a string value for a key from the registry. More... | |
virtual void | set (const UniConfKey &key, WvStringParm value) |
Stores a string value for a key into the registry. More... | |
virtual void | setv (const UniConfPairList &pairs) |
Stores multiple key-value pairs into the registry. More... | |
virtual bool | haschildren (const UniConfKey &key) |
Returns true if a key has children. More... | |
virtual Iter * | iterator (const UniConfKey &key) |
Returns an iterator over the children of the specified key. More... | |
virtual Iter * | recursiveiterator (const UniConfKey &key) |
Like iterator(), but the returned iterator is recursive, that is, it will return children of the immediate children, not just the immediate children themselves. More... | |
virtual void | add_callback (void *cookie, const UniConfGenCallback &callback) |
Adds a callback for change notification. More... | |
virtual void | del_callback (void *cookie) |
Removes a callback for change notification. | |
void | dispatch_delta (const UniConfKey &key, WvStringParm value) |
Immediately sends notification that a key has possibly changed. More... | |
void | hold_delta () |
Pauses notifications until matched with a call to unhold_delta(). More... | |
void | unhold_delta () |
Resumes notifications when each hold_delta() has been matched. More... | |
void | clear_delta () |
Clears the list of pending notifications without sending them. More... | |
void | flush_delta () |
Flushes the list of pending notifications by sending them. More... | |
void | delta (const UniConfKey &key, WvStringParm value) |
Call this when a key's value or children have possibly changed. More... | |
virtual void | prefetch (const UniConfKey &key, bool recursive) |
Indicate that we will eventually be interested in doing get(), haschildren(), or other "get-like" operations on a particular key or tree of keys. More... | |
virtual bool | exists (const UniConfKey &key) |
Without fetching its value, returns true if a key exists. More... | |
virtual int | str2int (WvStringParm s, int defvalue) const |
Converts a string to an integer. More... | |
virtual unsigned int | addRef ()=0 |
Indicate you are using this object. More... | |
virtual unsigned int | release ()=0 |
Indicate that you are finished using this object. More... | |
virtual IObject * | getInterface (const UUID &)=0 |
Returns the requested XPLC interface. More... | |
virtual IWeakRef * | getWeakRef ()=0 |
Return a weak reference to this object. More... | |
Protected Member Functions | |
virtual Iter * | do_iterator (const UniConfKey &key, bool recursive) |
void | conncallback () |
bool | do_select () |
void | setv_naive (const UniConfPairList &pairs) |
Communicates with a UniConfDaemon to fetch and store keys and values.
To mount, use the moniker prefix "unix:" followed by the path of the Unix domain socket used by the UniConfDaemon. Alternately, use the moniker prefix "tcp:" followed by the hostname, a colon, and the port of a machine that serves UniConfDaemon requests over TCP.
Definition at line 28 of file uniclientgen.h.
UniClientGen::UniClientGen | ( | IWvStream * | stream, |
WvStringParm | dst = WvString::null |
||
) |
Creates a generator which can communicate with a daemon using the specified stream.
"stream" is the raw connection
Definition at line 106 of file uniclientgen.cc.
References WvStream::setcallback().
|
virtual |
Determines if the generator is usable and working properly.
The default implementation always returns true.
Reimplemented from UniConfGen.
Definition at line 141 of file uniclientgen.cc.
References WvStreamClone::isok().
|
virtual |
Refreshes information about a key recursively.
May discard uncommitted data.
The default implementation always returns true.
Reimplemented from UniConfGen.
Definition at line 147 of file uniclientgen.cc.
References UniClientConn::REQ_REFRESH, and UniClientConn::writecmd().
|
virtual |
Flushes any commitment/notification buffers .
The default implementation always returns true. NOTE: This method should be 'protected'
Implements UniConfGen.
Definition at line 153 of file uniclientgen.cc.
References WvStream::callback(), WvStreamClone::isok(), and WvStream::isreadable().
Referenced by set().
|
virtual |
Commits any changes.
The default implementation does nothing.
Reimplemented from UniConfGen.
Definition at line 160 of file uniclientgen.cc.
References UniClientConn::REQ_COMMIT, and UniClientConn::writecmd().
|
virtual |
Fetches a string value for a key from the registry.
If the key doesn't exist, the return value has .isnull() == true.
Implements UniConfGen.
Definition at line 166 of file uniclientgen.cc.
References UniClientConn::REQ_GET, UniClientConn::writecmd(), and wvtcl_escape().
|
virtual |
Stores a string value for a key into the registry.
If the value is WvString::null, the key is deleted.
Implements UniConfGen.
Definition at line 182 of file uniclientgen.cc.
References flush_buffers(), UniConfGen::hold_delta(), UniClientConn::REQ_REMOVE, UniClientConn::REQ_SET, spacecat(), UniConfGen::unhold_delta(), UniClientConn::writecmd(), and wvtcl_escape().
Referenced by setv().
|
virtual |
Stores multiple key-value pairs into the registry.
If the value is WvString::null, the key is deleted.
Implements UniConfGen.
Definition at line 199 of file uniclientgen.cc.
References UniConfGen::hold_delta(), UniClientConn::REQ_SETV, set(), spacecat(), UniConfGen::unhold_delta(), UniClientConn::writecmd(), and wvtcl_escape().
|
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.
Reimplemented from UniConfGen.
Definition at line 228 of file uniclientgen.cc.
References UniClientConn::REQ_HASCHILDREN, UniClientConn::writecmd(), and wvtcl_escape().
|
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.
Implements UniConfGen.
Definition at line 265 of file uniclientgen.cc.
|
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.
Reimplemented from UniConfGen.
Definition at line 271 of file uniclientgen.cc.
|
virtualinherited |
Adds a callback for change notification.
Must not be reimplemented by subclasses of UniConfGen.
Implements IUniConfGen.
Definition at line 158 of file uniconfgen.cc.
Referenced by UniConfRoot::UniConfRoot().
|
inherited |
Immediately sends notification that a key has possibly changed.
Takes care of the details of invoking the callback.
Note: You probably want to be using delta() instead.
Definition at line 71 of file uniconfgen.cc.
Referenced by UniConfGen::delta(), and UniConfGen::flush_delta().
|
inherited |
Pauses notifications until matched with a call to unhold_delta().
While paused, notification events are placed into a pending list. Redundant notifications may be discarded.
Use this to safeguard non-reentrant code.
Definition at line 32 of file uniconfgen.cc.
Referenced by UniTransactionGen::commit(), UniMountGen::commit(), UniConfGen::delta(), UniConfGen::haschildren(), UniMountGen::mountgen(), UniTransactionGen::refresh(), UniMountGen::refresh(), UniTempGen::set(), set(), UniTransactionGen::set(), setv(), UniTransactionGen::setv(), and UniMountGen::unmount().
|
inherited |
Resumes notifications when each hold_delta() has been matched.
On resumption, dispatches all pending notifications except those that were destined to watches that were removed.
Use this to safeguard non-reentrant code.
Definition at line 38 of file uniconfgen.cc.
References UniConfGen::flush_delta().
Referenced by UniTransactionGen::commit(), UniMountGen::commit(), UniConfGen::delta(), UniConfGen::haschildren(), UniMountGen::mountgen(), UniTransactionGen::refresh(), UniMountGen::refresh(), UniTempGen::set(), set(), UniTransactionGen::set(), setv(), UniTransactionGen::setv(), and UniMountGen::unmount().
|
inherited |
Clears the list of pending notifications without sending them.
Does not affect the hold nesting count.
Definition at line 47 of file uniconfgen.cc.
|
inherited |
Flushes the list of pending notifications by sending them.
Does not affect the hold nesting count.
Definition at line 53 of file uniconfgen.cc.
References UniConfGen::dispatch_delta().
Referenced by UniConfGen::unhold_delta().
|
inherited |
Call this when a key's value or children have possibly changed.
If the hold nesting count is 0, the notification is sent immediately. Otherwise it is added to a pending list for later.
Definition at line 77 of file uniconfgen.cc.
References UniConfGen::dispatch_delta(), UniConfGen::hold_delta(), and UniConfGen::unhold_delta().
Referenced by UniTransactionGen::cancel_changes(), UniTransactionGen::cancel_values(), UniTransactionGen::create_value(), UniTransactionGen::deletion_simulator(), UniTransactionGen::deletion_simulator2(), UniTransactionGen::deletion_visitor(), UniListGen::gencallback(), UniFilterGen::gencallback(), UniTransactionGen::gencallback(), UniMountGen::mountgen(), UniTempGen::set(), UniRegistryGen::set(), UniPStoreGen::set(), and UniMountGen::unmount().
|
inlinevirtualinherited |
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.
Implements IUniConfGen.
Reimplemented in UniRetryGen, UniFilterGen, and UniUnwrapGen.
Definition at line 282 of file uniconfgen.h.
|
virtualinherited |
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().
Implements IUniConfGen.
Reimplemented in UniMountGen, UniRetryGen, UniFilterGen, UniPStoreGen, UniUnwrapGen, UniSecureGen, UniListGen, UniRegistryGen, UniFastRegetGen, and UniSlowGen.
Definition at line 120 of file uniconfgen.cc.
References UniConfGen::get(), and WvFastString::isnull().
|
virtualinherited |
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.
Implements IUniConfGen.
Definition at line 126 of file uniconfgen.cc.
|
pure virtualinherited |
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.
Referenced by WvIStreamList::execute(), IObjectImplInternal::getInterface(), StaticServiceHandler::getObject(), WeakRef::getObject(), WvIStreamList::post_select(), WvQtStreamClone::WvQtStreamClone(), and WvSSLStream::WvSSLStream().
|
pure virtualinherited |
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.
Referenced by WvIStreamList::execute(), mutate(), NewMoniker::resolve(), and MonikerService::resolve().
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.
|
pure virtualinherited |