Allow for subscribe callback to return any value

This commit changes the behaviour of the various subscribe flavors
such that the callback can break the loop by returning any non-null
value.

This would allow, for example, context to be retreived from the message
and then used in such a way to return it to the caller.

1 files changed, 2 insertions, 2 deletions

diff --git a/README.markdown b/README.markdown
index cb32804b..69783919 100644
--- a/README.markdown
+++ b/README.markdown
@@ -2898,7 +2898,7 @@ _**Description**_: Subscribe to channels by pattern
 ##### *Parameters*
 *patterns*: An array of patterns to match
 *callback*: Either a string or an array with an object and method.  The callback will get four arguments ($redis, $pattern, $channel, $message)
-
+*return value*: Mixed.  Any non-null return value in the callback will be returned to the caller.
 ##### *Example*
 ~~~
 function psubscribe($redis, $pattern, $chan, $msg) {
@@ -2928,7 +2928,7 @@ _**Description**_: Subscribe to channels. Warning: this function will probably c
 ##### *Parameters*
 *channels*: an array of channels to subscribe to  
 *callback*: either a string or an array($instance, 'method_name'). The callback function receives 3 parameters: the redis instance, the channel name, and the message.  
-
+*return value*:  Mixed.  Any non-null return value in the callback will be returned to the caller.
 ##### *Example*
 ~~~
 function f($redis, $chan, $msg) {