micro/broker/broker.go

71 lines
1.7 KiB
Go
Raw Permalink Normal View History

2016-12-14 18:41:48 +03:00
// Package broker is an interface used for asynchronous messaging
package broker
import (
"context"
"errors"
"github.com/unistack-org/micro/v3/metadata"
)
// DefaultBroker default broker
var DefaultBroker Broker = NewBroker()
2016-01-31 00:18:57 +03:00
// Broker is an interface used for asynchronous messaging.
type Broker interface {
Name() string
2019-07-07 14:33:47 +03:00
Init(...Option) error
Options() Options
2019-07-10 21:58:30 +03:00
Address() string
Connect(context.Context) error
Disconnect(context.Context) error
Publish(context.Context, string, *Message, ...PublishOption) error
Subscribe(context.Context, string, Handler, ...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.
type Handler func(Event) error
// Event is given to a subscription handler for processing
type Event interface {
Topic() string
Message() *Message
Ack() error
Error() error
}
// RawMessage is a raw encoded JSON value.
// It implements Marshaler and Unmarshaler and can be used to delay decoding or precompute a encoding.
type RawMessage []byte
// MarshalJSON returns m as the JSON encoding of m.
func (m *RawMessage) MarshalJSON() ([]byte, error) {
if m == nil {
return nil, nil
}
return *m, nil
}
// UnmarshalJSON sets *m to a copy of data.
func (m *RawMessage) UnmarshalJSON(data []byte) error {
if m == nil {
return errors.New("RawMessage UnmarshalJSON on nil pointer")
}
*m = append((*m)[0:0], data...)
return nil
}
// Message is used to transfer data
type Message struct {
Header metadata.Metadata // contains message metadata
Body RawMessage // contains message body
}
// Subscriber is a convenience return type for the Subscribe method
type Subscriber interface {
Options() SubscribeOptions
Topic() string
Unsubscribe(context.Context) error
}