mirror of https://github.com/go-redis/redis.git
Rework pubsub interface. Add timeout support.
This commit is contained in:
Vladimir Mihailenco
parent
9462848b74
commit
8d6a169007
|
|
@ -115,20 +115,19 @@ func ExamplePubSub() {
|
|||
pubsub, err := client.PubSubClient()
|
||||
defer pubsub.Close()
|
||||
|
||||
ch, err := pubsub.Subscribe("mychannel")
|
||||
_ = err
|
||||
err = pubsub.Subscribe("mychannel")
|
||||
|
||||
subscribeMsg := <-ch
|
||||
fmt.Println(subscribeMsg.Err, subscribeMsg.Name)
|
||||
msg, err := pubsub.Receive(0)
|
||||
fmt.Println(msg, err)
|
||||
|
||||
pub := client.Publish("mychannel", "hello")
|
||||
_ = pub.Err()
|
||||
|
||||
msg := <-ch
|
||||
fmt.Println(msg.Err, msg.Message)
|
||||
msg, err = pubsub.Receive(0)
|
||||
fmt.Println(msg, err)
|
||||
|
||||
// Output: <nil> subscribe
|
||||
// <nil> hello
|
||||
// Output: &{subscribe mychannel 1} <nil>
|
||||
// &{mychannel hello} <nil>
|
||||
}
|
||||
|
||||
func Get(client *redis.Client, key string) *redis.StringReq {
|
||||
|
|
|
|||
133
v2/pubsub.go
133
v2/pubsub.go
|
|
@ -2,14 +2,11 @@ package redis
|
|||
|
||||
import (
|
||||
"fmt"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
type PubSubClient struct {
|
||||
*baseClient
|
||||
|
||||
ch chan *Message
|
||||
once sync.Once
|
||||
}
|
||||
|
||||
func (c *Client) PubSubClient() (*PubSubClient, error) {
|
||||
|
|
@ -18,8 +15,6 @@ func (c *Client) PubSubClient() (*PubSubClient, error) {
|
|||
opt: c.opt,
|
||||
connPool: newSingleConnPool(c.connPool, nil, false),
|
||||
},
|
||||
|
||||
ch: make(chan *Message),
|
||||
}, nil
|
||||
}
|
||||
|
||||
|
|
@ -30,90 +25,88 @@ func (c *Client) Publish(channel, message string) *IntReq {
|
|||
}
|
||||
|
||||
type Message struct {
|
||||
Name, Channel, ChannelPattern, Message string
|
||||
Number int64
|
||||
|
||||
Err error
|
||||
Channel string
|
||||
Payload string
|
||||
}
|
||||
|
||||
func (c *PubSubClient) consumeMessages(cn *conn) {
|
||||
req := NewIfaceSliceReq()
|
||||
|
||||
for {
|
||||
msg := &Message{}
|
||||
|
||||
replyIface, err := req.ParseReply(cn.Rd)
|
||||
if err != nil {
|
||||
msg.Err = err
|
||||
c.ch <- msg
|
||||
return
|
||||
}
|
||||
reply, ok := replyIface.([]interface{})
|
||||
if !ok {
|
||||
msg.Err = fmt.Errorf("redis: unexpected reply type %T", replyIface)
|
||||
c.ch <- msg
|
||||
return
|
||||
}
|
||||
|
||||
msgName := reply[0].(string)
|
||||
switch msgName {
|
||||
case "subscribe", "unsubscribe", "psubscribe", "punsubscribe":
|
||||
msg.Name = msgName
|
||||
msg.Channel = reply[1].(string)
|
||||
msg.Number = reply[2].(int64)
|
||||
case "message":
|
||||
msg.Name = msgName
|
||||
msg.Channel = reply[1].(string)
|
||||
msg.Message = reply[2].(string)
|
||||
case "pmessage":
|
||||
msg.Name = msgName
|
||||
msg.ChannelPattern = reply[1].(string)
|
||||
msg.Channel = reply[2].(string)
|
||||
msg.Message = reply[3].(string)
|
||||
default:
|
||||
msg.Err = fmt.Errorf("redis: unsupported message name: %q", msgName)
|
||||
}
|
||||
c.ch <- msg
|
||||
}
|
||||
type PMessage struct {
|
||||
Channel string
|
||||
Pattern string
|
||||
Payload string
|
||||
}
|
||||
|
||||
func (c *PubSubClient) subscribe(cmd string, channels ...string) (chan *Message, error) {
|
||||
args := append([]string{cmd}, channels...)
|
||||
req := NewIfaceSliceReq(args...)
|
||||
type Subscription struct {
|
||||
Kind string
|
||||
Channel string
|
||||
Count int
|
||||
}
|
||||
|
||||
func (c *PubSubClient) Receive(timeout time.Duration) (interface{}, error) {
|
||||
cn, err := c.conn()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
cn.readTimeout = timeout
|
||||
|
||||
if err := c.writeReq(cn, req); err != nil {
|
||||
replyIface, err := NewIfaceSliceReq().ParseReply(cn.Rd)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
reply, ok := replyIface.([]interface{})
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("redis: unexpected reply type %T", replyIface)
|
||||
}
|
||||
|
||||
c.once.Do(func() {
|
||||
go c.consumeMessages(cn)
|
||||
})
|
||||
|
||||
return c.ch, nil
|
||||
switch msgName := reply[0].(string); msgName {
|
||||
case "subscribe", "unsubscribe", "psubscribe", "punsubscribe":
|
||||
return &Subscription{
|
||||
Kind: msgName,
|
||||
Channel: reply[1].(string),
|
||||
Count: int(reply[2].(int64)),
|
||||
}, nil
|
||||
case "message":
|
||||
return &Message{
|
||||
Channel: reply[1].(string),
|
||||
Payload: reply[2].(string),
|
||||
}, nil
|
||||
case "pmessage":
|
||||
return &PMessage{
|
||||
Pattern: reply[1].(string),
|
||||
Channel: reply[2].(string),
|
||||
Payload: reply[3].(string),
|
||||
}, nil
|
||||
default:
|
||||
return nil, fmt.Errorf("redis: unsupported message name: %q", msgName)
|
||||
}
|
||||
}
|
||||
|
||||
func (c *PubSubClient) Subscribe(channels ...string) (chan *Message, error) {
|
||||
return c.subscribe("SUBSCRIBE", channels...)
|
||||
}
|
||||
|
||||
func (c *PubSubClient) PSubscribe(patterns ...string) (chan *Message, error) {
|
||||
return c.subscribe("PSUBSCRIBE", patterns...)
|
||||
}
|
||||
|
||||
func (c *PubSubClient) unsubscribe(cmd string, channels ...string) error {
|
||||
args := append([]string{cmd}, channels...)
|
||||
req := NewIfaceSliceReq(args...)
|
||||
|
||||
func (c *PubSubClient) subscribe(cmd string, channels ...string) error {
|
||||
cn, err := c.conn()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
args := append([]string{cmd}, channels...)
|
||||
req := NewIfaceSliceReq(args...)
|
||||
return c.writeReq(cn, req)
|
||||
}
|
||||
|
||||
func (c *PubSubClient) Subscribe(channels ...string) error {
|
||||
return c.subscribe("SUBSCRIBE", channels...)
|
||||
}
|
||||
|
||||
func (c *PubSubClient) PSubscribe(patterns ...string) error {
|
||||
return c.subscribe("PSUBSCRIBE", patterns...)
|
||||
}
|
||||
|
||||
func (c *PubSubClient) unsubscribe(cmd string, channels ...string) error {
|
||||
cn, err := c.conn()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
args := append([]string{cmd}, channels...)
|
||||
req := NewIfaceSliceReq(args...)
|
||||
return c.writeReq(cn, req)
|
||||
}
|
||||
|
||||
|
|
|
|||
165
v2/redis_test.go
165
v2/redis_test.go
|
|
@ -2268,46 +2268,45 @@ func (t *RedisTest) TestPatternPubSub(c *C) {
|
|||
c.Assert(pubsub.Close(), IsNil)
|
||||
}()
|
||||
|
||||
ch, err := pubsub.PSubscribe("mychannel*")
|
||||
c.Assert(err, IsNil)
|
||||
c.Assert(ch, Not(IsNil))
|
||||
c.Assert(pubsub.PSubscribe("mychannel*"), IsNil)
|
||||
|
||||
pub := t.client.Publish("mychannel1", "hello")
|
||||
c.Assert(pub.Err(), IsNil)
|
||||
c.Assert(pub.Val(), Equals, int64(1))
|
||||
|
||||
err = pubsub.PUnsubscribe("mychannel*")
|
||||
c.Assert(pubsub.PUnsubscribe("mychannel*"), IsNil)
|
||||
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "psubscribe")
|
||||
c.Assert(msg.Channel, Equals, "mychannel*")
|
||||
c.Assert(msg.Number, Equals, int64(1))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "psubscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel*")
|
||||
c.Assert(subscr.Count, Equals, 1)
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "pmessage")
|
||||
c.Assert(msg.ChannelPattern, Equals, "mychannel*")
|
||||
c.Assert(msg.Channel, Equals, "mychannel1")
|
||||
c.Assert(msg.Message, Equals, "hello")
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.PMessage)
|
||||
c.Assert(subscr.Channel, Equals, "mychannel1")
|
||||
c.Assert(subscr.Pattern, Equals, "mychannel*")
|
||||
c.Assert(subscr.Payload, Equals, "hello")
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "punsubscribe")
|
||||
c.Assert(msg.Channel, Equals, "mychannel*")
|
||||
c.Assert(msg.Number, Equals, int64(0))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "punsubscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel*")
|
||||
c.Assert(subscr.Count, Equals, 0)
|
||||
}
|
||||
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err.(net.Error).Timeout(), Equals, true)
|
||||
c.Assert(msgi, IsNil)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -2318,13 +2317,7 @@ func (t *RedisTest) TestPubSub(c *C) {
|
|||
c.Assert(pubsub.Close(), IsNil)
|
||||
}()
|
||||
|
||||
ch, err := pubsub.Subscribe("mychannel")
|
||||
c.Assert(err, IsNil)
|
||||
c.Assert(ch, Not(IsNil))
|
||||
|
||||
ch2, err := pubsub.Subscribe("mychannel2")
|
||||
c.Assert(err, IsNil)
|
||||
c.Assert(ch2, Equals, ch)
|
||||
c.Assert(pubsub.Subscribe("mychannel", "mychannel2"), IsNil)
|
||||
|
||||
pub := t.client.Publish("mychannel", "hello")
|
||||
c.Assert(pub.Err(), IsNil)
|
||||
|
|
@ -2334,70 +2327,64 @@ func (t *RedisTest) TestPubSub(c *C) {
|
|||
c.Assert(pub.Err(), IsNil)
|
||||
c.Assert(pub.Val(), Equals, int64(1))
|
||||
|
||||
err = pubsub.Unsubscribe("mychannel")
|
||||
c.Assert(pubsub.Unsubscribe("mychannel", "mychannel2"), IsNil)
|
||||
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "subscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel")
|
||||
c.Assert(subscr.Count, Equals, 1)
|
||||
}
|
||||
|
||||
err = pubsub.Unsubscribe("mychannel2")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "subscribe")
|
||||
c.Assert(msg.Channel, Equals, "mychannel")
|
||||
c.Assert(msg.Number, Equals, int64(1))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "subscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel2")
|
||||
c.Assert(subscr.Count, Equals, 2)
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "subscribe")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.Message)
|
||||
c.Assert(subscr.Channel, Equals, "mychannel")
|
||||
c.Assert(subscr.Payload, Equals, "hello")
|
||||
}
|
||||
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
msg := msgi.(*redis.Message)
|
||||
c.Assert(msg.Channel, Equals, "mychannel2")
|
||||
c.Assert(msg.Number, Equals, int64(2))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
c.Assert(msg.Payload, Equals, "hello2")
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "message")
|
||||
c.Assert(msg.Channel, Equals, "mychannel")
|
||||
c.Assert(msg.Message, Equals, "hello")
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "unsubscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel")
|
||||
c.Assert(subscr.Count, Equals, 1)
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "message")
|
||||
c.Assert(msg.Channel, Equals, "mychannel2")
|
||||
c.Assert(msg.Message, Equals, "hello2")
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err, IsNil)
|
||||
subscr := msgi.(*redis.Subscription)
|
||||
c.Assert(subscr.Kind, Equals, "unsubscribe")
|
||||
c.Assert(subscr.Channel, Equals, "mychannel2")
|
||||
c.Assert(subscr.Count, Equals, 0)
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "unsubscribe")
|
||||
c.Assert(msg.Channel, Equals, "mychannel")
|
||||
c.Assert(msg.Number, Equals, int64(1))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
}
|
||||
|
||||
select {
|
||||
case msg := <-ch:
|
||||
c.Assert(msg.Err, Equals, nil)
|
||||
c.Assert(msg.Name, Equals, "unsubscribe")
|
||||
c.Assert(msg.Channel, Equals, "mychannel2")
|
||||
c.Assert(msg.Number, Equals, int64(0))
|
||||
case <-time.After(time.Second):
|
||||
c.Error("Channel is empty.")
|
||||
{
|
||||
msgi, err := pubsub.Receive(time.Second)
|
||||
c.Assert(err.(net.Error).Timeout(), Equals, true)
|
||||
c.Assert(msgi, IsNil)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue