forked from nytimes/gizmo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pubsub.go
39 lines (34 loc) · 1.29 KB
/
pubsub.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package pubsub
import (
"github.com/Sirupsen/logrus"
"github.com/golang/protobuf/proto"
)
// Log is the structured logger used throughout the package.
var Log = logrus.New()
// Publisher is a generic interface to encapsulate how we want our publishers
// to behave. Until we find reason to change, we're forcing all pubslishers
// to emit protobufs.
type Publisher interface {
// Publish will publish a message.
Publish(string, proto.Message) error
// Publish will publish a raw byte array as a message.
PublishRaw(string, []byte) error
}
// Subscriber is a generic interface to encapsulate how we want our subscribers
// to behave. For now the system will auto stop if it encounters any errors. If
// a user encounters a closed channel, they should check the Err() method to see
// what happened.
type Subscriber interface {
// Start will return a channel of raw messages.
Start() <-chan SubscriberMessage
// Err will contain any errors returned from the consumer connection.
Err() error
// Stop will initiate a graceful shutdown of the subscriber connection.
Stop() error
}
// SubscriberMessage is a struct to encapsulate subscriber messages and provide
// a mechanism for acknowledging messages _after_ they've been processed.
type SubscriberMessage interface {
Message() []byte
Done() error
}