pubsub

Documentation

Index

• Variables
• type Channel
• type PubSub
  • func New(pubsubType PubsubType, address string, password string) (PubSub, error)
• type PubsubType

Variables

var ErrInvalidPubsubType = errors.New("invalid pubsub type")

ErrInvalidPubsubType is error for invalid pubsub type.

Types

type Channel

type Channel interface {
	// Read and process incoming message. Param `data` should
	// be a pointer just like when using json.Unmarshal.
	Read(data interface{}) (<-chan interface{}, <-chan error)
	// Close subscription.
	Close() error
}

Channel is channel interface.

See usage example in example folder.

type PubSub

type PubSub interface {
	// Publish message to specific topic/channel.
	// Data will be encoded first before publishing.
	Publish(topic string, data interface{}) error
	// Subscribe to specific topic/channel.
	Subscribe(topic string) (interface{}, error)
	// Close pubsub client connection.
	Close() error
}

PubSub is pubsub interface.

For subscribe function, you have to convert the return type to Channel.

See usage example in example folder.

func New

func New(pubsubType PubsubType, address string, password string) (PubSub, error)

New to create new pubsub client depends on the type.

type PubsubType

type PubsubType int8

PubsubType is type for pubsub.

const (
	Redis PubsubType = iota + 1
	RabbitMQ
	NSQ
)

Available types for pubsub.