summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-03 12:01:08 +0100
committerPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-03 12:01:08 +0100
commitcdd026ac791e0767b84f8eafc7e3bddaf5142f4d (patch)
treee23b2f40f45a1a6d02123c22e6c5c5a09880a347
parentf023f9cfd51bb8f004362b8efabdbdf8e4f83a1f (diff)
Style
-rw-r--r--README.md8
1 files changed, 1 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1526642..76e5961 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ code using hiredis should not be a big pain. The key thing to keep in mind when
upgrading is that hiredis >= 0.9.0 uses a `redisContext*` to keep state, in contrast to
the stateless 0.0.1 that only has a file descriptor to work with.
-## SYNCHRONOUS API
+## Synchronous API
To consume the synchronous API, there are only a few function calls that need to be introduced:
@@ -86,30 +86,24 @@ The standard replies that `redisCommand` are of the type `redisReply`. The
was received:
* **`REDIS_REPLY_STATUS`**:
-
The command replied with a status reply. The status string can be accessed using `reply->str`.
The length of this string can be accessed using `reply->len`.
* **`REDIS_REPLY_ERROR`**:
-
The command replied with an error. The error string can be accessed identical to `REDIS_REPLY_STATUS`.
* **`REDIS_REPLY_INTEGER`**:
-
The command replied with an integer. The integer value can be accessed using the
`reply->integer` field of type `long long`.
* **`REDIS_REPLY_NIL`**:
-
The command replied with a **nil** object. There is no data to access.
* **`REDIS_REPLY_STRING`**:
-
A bulk (string) reply. The value of the reply can be accessed using `reply->str`.
The length of this string can be accessed using `reply->len`.
* **`REDIS_REPLY_ARRAY`**:
-
A multi bulk reply. The number of elements in the multi bulk reply is stored in
`reply->elements`. Every element in the multi bulk reply is a `redisReply` object as well
and can be accessed via `reply->elements[..index..]`.