Return-Path: X-Original-To: apmail-curator-commits-archive@minotaur.apache.org Delivered-To: apmail-curator-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A22F717CE0 for ; Tue, 4 Nov 2014 21:21:49 +0000 (UTC) Received: (qmail 65426 invoked by uid 500); 4 Nov 2014 21:21:49 -0000 Delivered-To: apmail-curator-commits-archive@curator.apache.org Received: (qmail 65356 invoked by uid 500); 4 Nov 2014 21:21:49 -0000 Mailing-List: contact commits-help@curator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@curator.apache.org Delivered-To: mailing list commits@curator.apache.org Received: (qmail 65325 invoked by uid 99); 4 Nov 2014 21:21:49 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 04 Nov 2014 21:21:49 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 118D28AEFCB; Tue, 4 Nov 2014 21:21:49 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: randgalt@apache.org To: commits@curator.apache.org Date: Tue, 04 Nov 2014 21:21:49 -0000 Message-Id: <44c829512f0d4c8885889be430d7b3c8@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [1/3] git commit: temp commit Repository: curator Updated Branches: refs/heads/master 221f481f6 -> ef2ca5786 temp commit Project: http://git-wip-us.apache.org/repos/asf/curator/repo Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/debc475b Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/debc475b Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/debc475b Branch: refs/heads/master Commit: debc475bfed00eaf61ae4448fdf599bc5cbc1eae Parents: 1cd0522 Author: randgalt Authored: Tue Nov 4 16:21:20 2014 -0500 Committer: randgalt Committed: Tue Nov 4 16:21:20 2014 -0500 ---------------------------------------------------------------------- .../src/site/confluence/Tree-cache.confluence | 39 -------------------- .../src/site/confluence/xtree-cache.confluence | 39 ++++++++++++++++++++ 2 files changed, 39 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/curator/blob/debc475b/curator-recipes/src/site/confluence/Tree-cache.confluence ---------------------------------------------------------------------- diff --git a/curator-recipes/src/site/confluence/Tree-cache.confluence b/curator-recipes/src/site/confluence/Tree-cache.confluence deleted file mode 100644 index 0d67857..0000000 --- a/curator-recipes/src/site/confluence/Tree-cache.confluence +++ /dev/null @@ -1,39 +0,0 @@ -h1. Tree Cache - -h2. Description -A utility that attempts to keep all data from all children of a ZK path locally cached. This class will watch the ZK path, respond to update/create/delete events, pull down the data, etc. You can register a listener that will get notified when changes occur. - -h2. Participating Classes -* TreeCache -* TreeCacheListener -* TreeCacheEvent -* ChildData - -h2. Usage -h3. Creating a TreeCache -{code} -public TreeCache(CuratorFramework client, - String path, - boolean cacheData) -Parameters: -client - the client -path - path to watch -cacheData - if true, node contents are cached in addition to the stat -{code} - -h2. General Usage -The cache must be started by calling {{start()}}. Call {{close()}} when you are through with the cache. - -At any time, call {{getCurrentChildren()}} to get the current state of the cache. Alternatively, call {{getCurrentData()}} to get -the data for a given path that's being monitored. - -You can also register to be notified when a change occurs by calling {{getListenable()}} and then: -{code} -public void addListener(TreeCacheListener listener) - Add a change listener -Parameters: -listener - the listener -{code} - -h2. Error Handling -TreeCache instances internally monitor a {{ConnectionStateListener}}. If the connection state changes, the cache will receive messages detailing the change. http://git-wip-us.apache.org/repos/asf/curator/blob/debc475b/curator-recipes/src/site/confluence/xtree-cache.confluence ---------------------------------------------------------------------- diff --git a/curator-recipes/src/site/confluence/xtree-cache.confluence b/curator-recipes/src/site/confluence/xtree-cache.confluence new file mode 100644 index 0000000..0d67857 --- /dev/null +++ b/curator-recipes/src/site/confluence/xtree-cache.confluence @@ -0,0 +1,39 @@ +h1. Tree Cache + +h2. Description +A utility that attempts to keep all data from all children of a ZK path locally cached. This class will watch the ZK path, respond to update/create/delete events, pull down the data, etc. You can register a listener that will get notified when changes occur. + +h2. Participating Classes +* TreeCache +* TreeCacheListener +* TreeCacheEvent +* ChildData + +h2. Usage +h3. Creating a TreeCache +{code} +public TreeCache(CuratorFramework client, + String path, + boolean cacheData) +Parameters: +client - the client +path - path to watch +cacheData - if true, node contents are cached in addition to the stat +{code} + +h2. General Usage +The cache must be started by calling {{start()}}. Call {{close()}} when you are through with the cache. + +At any time, call {{getCurrentChildren()}} to get the current state of the cache. Alternatively, call {{getCurrentData()}} to get +the data for a given path that's being monitored. + +You can also register to be notified when a change occurs by calling {{getListenable()}} and then: +{code} +public void addListener(TreeCacheListener listener) + Add a change listener +Parameters: +listener - the listener +{code} + +h2. Error Handling +TreeCache instances internally monitor a {{ConnectionStateListener}}. If the connection state changes, the cache will receive messages detailing the change.