Patrick Peralta created CURATOR-124:
---------------------------------------
Summary: PathChildrenCache StartMode documentation improvement
Key: CURATOR-124
URL: https://issues.apache.org/jira/browse/CURATOR-124
Project: Apache Curator
Issue Type: Improvement
Components: Recipes
Reporter: Patrick Peralta
Priority: Minor
When using {{PathChildrenCache}}, the documented behavior for
{{StartMode.NORMAL}} is as follows:
{panel}
cache will _not_ be primed. i.e. it will start empty and you will receive
events for all nodes added, etc.
{panel}
However my observation is that the cache is primed. This was confirmed by
Jordan in an email thread on the mailing list on June 23 2014:
{panel}
Yes, POST_INITIALIZED_EVENT is the same as NORMAL except you get the
INITIALIZED event. You can see this in
TestPathChildrenCache.testChildrenInitialized(). Please send a PR with doc
updates if you think they can be improved.
{panel}
When I looked into {{TestPathChildrenCache.testChildrenInitialized()}}, it
appears to be testing the {{POST_INITIALIZED_EVENT}} behavior. I will add a new
test {{testChildrenInitializedNormal}} to assert the cache initialization
behavior describe above for mode {{NORMAL}}. Furthermore I will modify the doc
to indicate this behavior.
This issue will be updated with a link to the PR when it is ready.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
