gopubsub

README

gpubsub

gpubsub is a topic-based publish/subscribe library written in golang.

Requirement

Go (>= 1.8)

Installation

go get github.com/hlts2/gopubsub

Example

To subscribe:

ps := gopubsub.NewPubSub()

subscriber := ps.Subscribe("t1")

To add subscribe:

subscriber := ps.Subscribe("t1")

// Adds subscriptions
ps.AddSubsrcibe("t2", subscriber)

To publish:

// publish message to topic asyncronously
ps.Publish("t1", "Hello World!!")

// Because the message type is `interface{}`, you can publish anything
ps.Publish("t1", func() {
  fmt.Println("Hello World!!")
})

To Cancel specific subscription:

ps.UnSubscribe("t1")

To fetch published message

message := <-subscriber.Read()

Author

hlts2

LICENSE

gopubsub released under MIT license, refer LICENSE file.

Documentation

Index

• type PubSub
  • func NewPubSub() *PubSub
  • func (p *PubSub) AddSubsrcibe(topic string, target Subscriber) Subscriber
  • func (p *PubSub) Publish(topic string, message interface{})
  • func (p *PubSub) Subscribe(topic string) Subscriber
  • func (p *PubSub) UnSubscribe(topic string, target Subscriber)
• type Subscriber

Types

type PubSub

type PubSub struct {
	// contains filtered or unexported fields
}

PubSub is pubsub messasing object

func NewPubSub

func NewPubSub() *PubSub

NewPubSub returns PubSub object

func (*PubSub) AddSubsrcibe

func (p *PubSub) AddSubsrcibe(topic string, target Subscriber) Subscriber

AddSubsrcibe adds subscribes into a topic

func (*PubSub) Publish

func (p *PubSub) Publish(topic string, message interface{})

Publish sends a message to subscribers subscribing to topic

func (*PubSub) Subscribe

func (p *PubSub) Subscribe(topic string) Subscriber

Subscribe subscribes to a topic

func (*PubSub) UnSubscribe

func (p *PubSub) UnSubscribe(topic string, target Subscriber)

UnSubscribe unsubscribes topic

type Subscriber

type Subscriber interface {
	Read() <-chan interface{}
}

Subscriber is interface that wraps the Read methods