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/01 21:53:33 UTC
[4/4] git commit: completed initial doc
completed initial doc
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/f3ec63cb
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/f3ec63cb
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/f3ec63cb
Branch: refs/heads/curator-rpc
Commit: f3ec63cb6b29d6c9bf586f706596a2800407a488
Parents: 673e6dc
Author: randgalt <ra...@apache.org>
Authored: Sun Jun 1 14:53:23 2014 -0500
Committer: randgalt <ra...@apache.org>
Committed: Sun Jun 1 14:53:23 2014 -0500
----------------------------------------------------------------------
.../curator/x/rpc/idl/structs/DeleteSpec.java | 6 +-
.../curator/x/rpc/idl/structs/LeaderResult.java | 6 +-
.../src/site/confluence/reference.confluence | 81 +++++++++++++++++++-
3 files changed, 82 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/f3ec63cb/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/DeleteSpec.java
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/DeleteSpec.java b/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/DeleteSpec.java
index 2d418ee..18f8dd2 100644
--- a/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/DeleteSpec.java
+++ b/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/DeleteSpec.java
@@ -34,21 +34,17 @@ public class DeleteSpec
public String asyncContext;
@ThriftField(4)
- public boolean compressed;
-
- @ThriftField(5)
public Version version;
public DeleteSpec()
{
}
- public DeleteSpec(String path, boolean guaranteed, String asyncContext, boolean compressed, Version version)
+ public DeleteSpec(String path, boolean guaranteed, String asyncContext, Version version)
{
this.path = path;
this.guaranteed = guaranteed;
this.asyncContext = asyncContext;
- this.compressed = compressed;
this.version = version;
}
}
http://git-wip-us.apache.org/repos/asf/curator/blob/f3ec63cb/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/LeaderResult.java
----------------------------------------------------------------------
diff --git a/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/LeaderResult.java b/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/LeaderResult.java
index 3616f3c..429294b 100644
--- a/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/LeaderResult.java
+++ b/curator-x-rpc/src/main/java/org/apache/curator/x/rpc/idl/structs/LeaderResult.java
@@ -28,15 +28,15 @@ public class LeaderResult
public LeaderProjection projection;
@ThriftField(2)
- public boolean hasLeadership;
+ public boolean isLeader;
public LeaderResult()
{
}
- public LeaderResult(LeaderProjection projection, boolean hasLeadership)
+ public LeaderResult(LeaderProjection projection, boolean isLeader)
{
this.projection = projection;
- this.hasLeadership = hasLeadership;
+ this.isLeader = isLeader;
}
}
http://git-wip-us.apache.org/repos/asf/curator/blob/f3ec63cb/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 d23e9e1..0ecb26b 100644
--- a/curator-x-rpc/src/site/confluence/reference.confluence
+++ b/curator-x-rpc/src/site/confluence/reference.confluence
@@ -1,6 +1,6 @@
[[Curator RPC Proxy|index.html]] / Reference
-h1. API and Struct Reference
+h1. API Reference
h2. CuratorService
@@ -31,9 +31,9 @@ h2. CuratorService
h2. EventService
||API||Arguments||Return Value||Description||
-|getNextEvent|CuratorProjection|Returns the next queued event for the given CuratorProjection. If no events are queued within the [[configured|configuration.html]] ping time, a PING event is returned.|
+|getNextEvent|CuratorProjection|CuratorEvent|Returns the next queued event for the given CuratorProjection. If no events are queued within the [[configured|configuration.html]] ping time, a PING event is returned.|
-See the [[Events Page|events.html]] for the Event schema reference.
+See the [[Events Page|events.html]] for the CuratorEvent schema reference.
h2. DiscoveryService
@@ -44,3 +44,78 @@ h2. DiscoveryService
|getInstance|provider projection|DiscoveryInstance|Return a single instance for the given service|
|getAllInstances|provider projection|list of DiscoveryInstance|Return all instances for the given service|
|noteError|provider projection, service id|void|Note an error for the given service instance|
+
+h1. Struct Reference
+
+_Required fields have (r) in the description_
+
+h2. CreateSpec
+
+||Field||Type||Description||
+|path|string|(r) 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|(r) 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|(r) 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|(r) the ZNode path|
+|data|bytes|(r) 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|(r) 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|(r) 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
+
+||Field||Type||Description||
+|projection|LeaderProjection|the projection of the leader|
+|isLeader|bool|true if this projection is the leader|
+
+h2. Participant
+
+||Field||Type||Description||
+|id|string|participant id|
+|isLeader|bool|true if this participant is the leader|
+
+h2. ChildData
+
+||Field||Type||Description||
+|path|string|the ZNode path|
+|stat|Stat|ZooKeeper stat for the node|
+|data|bytes|node data or null|