micro/broker/broker.go

70 lines
1.6 KiB
Go
Raw Normal View History

2016-12-14 18:41:48 +03:00
// Package broker is an interface used for asynchronous messaging
package broker
2016-01-31 00:18:57 +03:00
// Broker is an interface used for asynchronous messaging.
type Broker interface {
2019-07-07 14:33:47 +03:00
Init(...Option) error
Options() Options
Connect() error
Disconnect() error
2019-07-07 14:36:14 +03:00
Publish(topic string, m *Message, opts ...PublishOption) error
Subscribe(topic string, h Handler, opts ...SubscribeOption) (Subscriber, error)
2015-12-20 00:56:14 +03:00
String() string
}
2015-12-23 22:07:26 +03:00
// Handler is used to process messages via a subscription of a topic.
// The handler is passed a publication interface which contains the
// message and optional Ack method to acknowledge receipt of the message.
2019-07-07 14:44:09 +03:00
type Handler func(Event) error
type Message struct {
Header map[string]string
Body []byte
}
2019-07-07 14:44:09 +03:00
// Event is given to a subscription handler for processing
type Event interface {
2015-12-23 22:07:26 +03:00
Topic() string
Message() *Message
Ack() error
}
// Subscriber is a convenience return type for the Subscribe method
type Subscriber interface {
Options() SubscribeOptions
Topic() string
Unsubscribe() error
}
var (
2016-03-16 01:12:28 +03:00
DefaultBroker Broker = newHttpBroker()
)
2016-03-16 01:12:28 +03:00
func NewBroker(opts ...Option) Broker {
return newHttpBroker(opts...)
}
2015-12-23 22:07:26 +03:00
func Init(opts ...Option) error {
return DefaultBroker.Init(opts...)
}
func Connect() error {
return DefaultBroker.Connect()
}
func Disconnect() error {
return DefaultBroker.Disconnect()
}
2015-12-23 22:07:26 +03:00
func Publish(topic string, msg *Message, opts ...PublishOption) error {
return DefaultBroker.Publish(topic, msg, opts...)
}
2015-12-23 22:07:26 +03:00
func Subscribe(topic string, handler Handler, opts ...SubscribeOption) (Subscriber, error) {
return DefaultBroker.Subscribe(topic, handler, opts...)
}
2015-12-20 00:56:14 +03:00
func String() string {
return DefaultBroker.String()
}