Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #415 from philips/fix-lock-docs

Browse Source 
fix(README): fixup lock docs
This commit is contained in:
Ben Johnson 2013-12-23 05:53:23 -08:00
commit 4748da1e09
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -971,22 +971,22 @@ An HTML dashboard can be found at `http://127.0.0.1:4001/mod/dashboard/```
### Lock ### Lock
The Lock module implements a fair lock that can be used when lots of clients want access to a single resource. The Lock module implements a fair lock that can be used when lots of clients want access to a single resource.
A lock can be associated with a name. A lock can be associated with a value.
The name is unique so if a lock tries to request a name that is already queued for a lock then it will find it and watch until that name obtains the lock. The value is unique so if a lock tries to request a value that is already queued for a lock then it will find it and watch until that value obtains the lock.
If you lock the same name on a key from two separate curl sessions they'll both return at the same time. If you lock the same value on a key from two separate curl sessions they'll both return at the same time.
Here's the API: Here's the API:
**Acquire a lock (with no name) for "customer1"** **Acquire a lock (with no value) for "customer1"**
```sh ```sh
curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60
``` ```
**Acquire a lock for "customer1" that is associated with the name "bar"** **Acquire a lock for "customer1" that is associated with the value "bar"**
```sh ```sh
curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d name=bar curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d value=bar
``` ```
**Renew the TTL on the "customer1" lock for index 2** **Renew the TTL on the "customer1" lock for index 2**
@ -995,13 +995,13 @@ curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d name=bar
curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d index=2 curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d index=2
``` ```
**Renew the TTL on the "customer1" lock for name "customer1"** **Renew the TTL on the "customer1" lock for value "customer1"**
```sh ```sh
curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d name=bar curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d value=bar
``` ```
**Retrieve the current name for the "customer1" lock.** **Retrieve the current value for the "customer1" lock.**
```sh ```sh
curl http://127.0.0.1:4001/mod/v2/lock/customer1 curl http://127.0.0.1:4001/mod/v2/lock/customer1
@ -1019,10 +1019,10 @@ curl http://127.0.0.1:4001/mod/v2/lock/customer1?field=index
curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?index=customer1 curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?index=customer1
``` ```
**Delete the "customer1" lock with the name "bar"** **Delete the "customer1" lock with the value "bar"**
```sh ```sh
curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?name=bar curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?value=bar
``` ```