From abd76f83547983fcdeee25fdf991a7ad9b75e6dc Mon Sep 17 00:00:00 2001 From: Matt Ranney Date: Thu, 23 Sep 2010 12:21:02 -0700 Subject: [PATCH] Update docs for end() and quit() --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b73bba7a5a..e5cce90d81 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Simple example, included as `example.js`: replies.forEach(function (reply, i) { console.log(" " + i + ": " + reply); }); - client.end(); + client.quit(); }); This will display: @@ -105,16 +105,22 @@ to `127.0.0.1`. If you have Redis running on the same computer as node, then th ## client.end() Forcibly close the connection to the Redis server. Note that this does not wait until all replies have been parsed. -If you want to exit cleanly, call `client.quit()` to send the `QUIT` command. +If you want to exit cleanly, call `client.quit()` to send the `QUIT` command after you have handled all replies. + +This example closes the connection to the Redis server before the replies have been read. You probably don't +want to do this: var redis = require("redis"), client = redis.createClient(); client.set("foo_rand000000000000", "some fantastic value"); client.get("foo_rand000000000000", function (err, reply) { - console.log(reply.toString()); + console.log(reply.toString()); }); - client.quit(); + client.end(); + +`client.end()` is useful for timeout cases where something is stuck or taking too long and you want +to start over. ## Publish / Subscribe