You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ra...@apache.org on 2014/06/07 20:19:41 UTC
[43/50] [abbrv] git commit: doc wip
doc wip
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/b583407d
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/b583407d
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/b583407d
Branch: refs/heads/master
Commit: b583407d4e010935d01e09c3cb52bd20c741e107
Parents: 29ef0c8
Author: randgalt <ra...@apache.org>
Authored: Mon Jun 2 14:56:28 2014 -0500
Committer: randgalt <ra...@apache.org>
Committed: Mon Jun 2 14:56:28 2014 -0500
----------------------------------------------------------------------
.../site/confluence/configuration.confluence | 26 ++++----
.../src/site/confluence/deploy.confluence | 4 +-
.../src/site/confluence/reference.confluence | 68 ++++++++++----------
.../src/site/confluence/usage.confluence | 8 +--
4 files changed, 53 insertions(+), 53 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/b583407d/curator-x-rpc/src/site/confluence/configuration.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/configuration.confluence b/curator-x-rpc/src/site/confluence/configuration.confluence
index 21912ae..72d2af0 100644
--- a/curator-x-rpc/src/site/confluence/configuration.confluence
+++ b/curator-x-rpc/src/site/confluence/configuration.confluence
@@ -98,12 +98,12 @@ Durations are strings that specify a time duration. Examples:
h3. Thrift
-||Name||Type||Default Value||Description||
-|bindAddress|string|"bindAddress"|Address for server to bind to|
-|port|int|_none_|port to listen on. *required*|
-|idleConnectionTimeout|int|60 seconds|timeout period between receiving requests from a client connection. If the timeout is exceeded (no complete requests have arrived from the client within the timeout), the server will disconnect the idle client.|
-|transportName|string|"framed"|the name of the transport (frame codec) that this server will handle. The available options by default are 'unframed', 'buffered', and 'framed'. Additional modules may install other options.|
-|protocolName|string|"binary"|name of the protocol that this server will speak. The available options by default are 'binary' and 'compact'. Additional modules may install other options.|
+||Name||Type||Default Value||Required||Description||
+|port|int|_none_|*Y*|port to listen on.|
+|bindAddress|string|"localhost"|\-|Address for server to bind to|
+|idleConnectionTimeout|int|60 seconds|\-|timeout period between receiving requests from a client connection. If the timeout is exceeded (no complete requests have arrived from the client within the timeout), the server will disconnect the idle client.|
+|transportName|string|"framed"|\-|the name of the transport (frame codec) that this server will handle. The available options by default are 'unframed', 'buffered', and 'framed'. Additional modules may install other options.|
+|protocolName|string|"binary"|\-|name of the protocol that this server will speak. The available options by default are 'binary' and 'compact'. Additional modules may install other options.|
h3. Logging
@@ -112,13 +112,13 @@ on specifying the logging configuration.
h3. Connection
-||Name||Type||Default Value||Description||
-|name|string|_none_|Unique name for the connection. *required*|
-|connectionString|string|_none_|ZooKeeper connection string (e.g. "host1:2181,host2:2181"). *required*|
-|sessionLength|Duration|1 minute|duration for the ZooKeeper session|
-|connectionTimeout|Duration|15 seconds|duration for connecting|
-|retry|Retry|an exponential\-backoff policy|The Retry Policy to use|
-|authorization|Authorization|null|Authorization spec|
+||Name||Type||Default Value||Required||Description||
+|name|string|_none_|*Y*|Unique name for the connection.|
+|connectionString|string|_none_|*Y*|ZooKeeper connection string (e.g. "host1:2181,host2:2181").|
+|sessionLength|Duration|1 minute|\-|duration for the ZooKeeper session|
+|connectionTimeout|Duration|15 seconds|\-|duration for connecting|
+|retry|Retry|an exponential\-backoff policy|\-|The Retry Policy to use|
+|authorization|Authorization|null|\-|Authorization spec|
h3. Retry
http://git-wip-us.apache.org/repos/asf/curator/blob/b583407d/curator-x-rpc/src/site/confluence/deploy.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/deploy.confluence b/curator-x-rpc/src/site/confluence/deploy.confluence
index 8c93cb8..3f5053b 100644
--- a/curator-x-rpc/src/site/confluence/deploy.confluence
+++ b/curator-x-rpc/src/site/confluence/deploy.confluence
@@ -4,8 +4,8 @@ h1. Deployment
h2. Running
-Curator RPC is built as an "uber" Java JAR and can be downloaded from Maven Central. Go to [[http://search.maven.org/]] and search for
-"curator\-x\-rpc" and download the JAR for the latest version. This JAR can be run directly ala:
+Curator RPC is built as an "uber" Java JAR and can be downloaded from Maven Central. Go to [[http://search.maven.org/|http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.curator%22%20AND%20a%3A%22curator-x-rpc%22]]
+and search for "curator\-x\-rpc" and download the JAR for the latest version. This JAR can be run directly ala:
{noformat}
java -jar curator-x-rpc-VERSION.jar <argument>
http://git-wip-us.apache.org/repos/asf/curator/blob/b583407d/curator-x-rpc/src/site/confluence/reference.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/reference.confluence b/curator-x-rpc/src/site/confluence/reference.confluence
index dde323f..602906e 100644
--- a/curator-x-rpc/src/site/confluence/reference.confluence
+++ b/curator-x-rpc/src/site/confluence/reference.confluence
@@ -49,55 +49,55 @@ h1. Struct Reference
h2. CreateSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|data|bytes|data for the node|
-|mode|CreateMode|PERSISTENT, PERSISTENT\_SEQUENTIAL, EPHEMERAL, or EPHEMERAL\_SEQUENTIAL|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
-|compressed|bool|if true, compress the data|
-|creatingParentsIfNeeded|bool|if true, create any needed parent nodes|
-|withProtection|bool|if true, use Curator protection|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|data|bytes|\-|data for the node|
+|mode|CreateMode|\-|PERSISTENT, PERSISTENT\_SEQUENTIAL, EPHEMERAL, or EPHEMERAL\_SEQUENTIAL|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+|compressed|bool|\-|if true, compress the data|
+|creatingParentsIfNeeded|bool|\-|if true, create any needed parent nodes|
+|withProtection|bool|\-|if true, use Curator protection|
h2. DeleteSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|guaranteed|bool|if true, use guaranteed deletion|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
-|compressed|bool|if true, compress the data|
-|version|Version|if not null, uses Version.version when deleting the node. Otherwise, \-1 is used.|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|guaranteed|bool|\-|if true, use guaranteed deletion|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+|compressed|bool|\-|if true, compress the data|
+|version|Version|\-|if not null, uses Version.version when deleting the node. Otherwise, \-1 is used.|
h2. GetDataSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|watched|bool|if true, trigger watch events for this node|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
-|decompressed|bool|if true, decompress the data|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|watched|bool|\-|if true, trigger watch events for this node|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+|decompressed|bool|\-|if true, decompress the data|
h2. SetDataSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|data|bytes|data for the node \- *required*|
-|watched|bool|if true, trigger watch events for this node|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
-|compressed|bool|if true, compress the data|
-|version|Version|if not null, uses Version.version when setting the node data. Otherwise, \-1 is used.|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|data|bytes|*Y*|data for the node|
+|watched|bool|\-|if true, trigger watch events for this node|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+|compressed|bool|\-|if true, compress the data|
+|version|Version|\-|if not null, uses Version.version when setting the node data. Otherwise, \-1 is used.|
h2. ExistsSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|watched|bool|if true, trigger watch events for this node|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|watched|bool|\-|if true, trigger watch events for this node|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
h2. GetChildrenSpec
-||Field||Type||Description||
-|path|string|the ZNode path \- *required*|
-|watched|bool|if true, trigger watch events for this node|
-|asyncContext|string|if not null, createNode() is performed asynchronously and this is the context used in the async message|
+||Field||Type||Required||Description||
+|path|string|*Y*|the ZNode path|
+|watched|bool|\-|if true, trigger watch events for this node|
+|asyncContext|string|\-|if not null, createNode() is performed asynchronously and this is the context used in the async message|
h2. LeaderResult
http://git-wip-us.apache.org/repos/asf/curator/blob/b583407d/curator-x-rpc/src/site/confluence/usage.confluence
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/site/confluence/usage.confluence b/curator-x-rpc/src/site/confluence/usage.confluence
index e9da75f..57bc14c 100644
--- a/curator-x-rpc/src/site/confluence/usage.confluence
+++ b/curator-x-rpc/src/site/confluence/usage.confluence
@@ -72,14 +72,14 @@ h2. Usage
Once initialized, use recipes/APIs as needed. Here is an example of using the lock recipe:
{code}
-lockId = client.acquireLock(curatorProjection, "/mylock", 10000);
+lockId = client.acquireLock(curatorProjection, "/mylock", 10000)
if lockId.id == null {
// lock attempt failed. Throw exception, etc.
}
// you now own the lock
-client.closeGenericProjection(curatorProjection, lockId.id);
+client.closeGenericProjection(curatorProjection, lockId.id)
{code}
Here is an example of using the path cache:
@@ -89,7 +89,7 @@ cacheProjection = client.startPathChildrenCache(curatorProjection, "/path", true
...
-data = client.getPathChildrenCacheDataForPath(curatorProjection, cacheProjection, "/path/child");
+data = client.getPathChildrenCacheDataForPath(curatorProjection, cacheProjection, "/path/child")
...
@@ -105,7 +105,7 @@ if event.type == PATH_CHILDREN_CACHE {
...
// when done with the cache, close it
-client.closeGenericProjection(curatorProjection, cacheProjection.id);
+client.closeGenericProjection(curatorProjection, cacheProjection.id)
{code}
h2. Reference