pubsub

type Connection interface {
	Close() error
	Options() Options
}

type Message interface {
	// Messages implement io.Reader to access the payload data.
	io.Reader

	Unmarshal(v interface{}) error

	// Done indicates the client is finished with the message, and the
	// underlying implementation may free its resources. Clients should ensure
	// to call Done for every received message.
	Done() error
}

type Option func(*Options)

type Options struct {
	Endpoints  []string
	Username   string
	Password   string
	TLSConfig  *tls.Config
	Serializer serializer.Serializer
	Context    context.Context
}

type PublishOption func(*PublishOptions)

type PublishOptions struct {
	Context context.Context
}

type Publisher interface {
	// Publish a single message, described by an interface using the serializer.
	Publish(key string, i interface{}) error

	// Publish a single message, described by an io.Reader, to the given key.
	PublishReader(key string, r io.Reader) error

	// End the publisher on channel.
	End(key string) error

	// Stop the publisher.
	Stop() error
}

type SubscribeOption func(*SubscribeOptions)

type SubscribeOptions struct {
	Context context.Context
}

type Subscriber interface {
	// Start returns a channel of messages that the caller should consume.
	// Failure to keep up with the incoming messages will have different
	// consequences depending on the concrete implementation of the subscriber.
	//
	// The channel will be closed when the subscriber encounters an error, or
	// when the caller invokes Stop, whichever comes first.
	Start() <-chan Message

	// Err returns the error that was responsible for closing the channel of
	// incoming messages.
	Err() error

	// Stop the subscriber, closing the channel that was returned by Start.
	Stop() error
}