broker

README

CloudEvents

Broker implementation provides queuing, backpressure, filtering

CloudEvents has multiple transports (http, pubsub, kafka...) available

Concepts

Actors

• Event Source
• Event Sink
• Broker

Messaging patterns

• Fire and Forgot
• Request and Response

Documentation

Index

• Constants
• type Broker
  • func NewBroker(opts ...Option) Broker
• type Handler
• type Option
  • func Context(ctx context.Context) Option
  • func Name(n string) Option
• type Options
• type PublishOption
  • func PublishAsync(b bool) PublishOption
  • func PublishContext(ctx context.Context) PublishOption
• type PublishOptions
• type Publisher
• type SubscribeOption
  • func SubscribeContext(ctx context.Context) SubscribeOption
• type SubscribeOptions
• type Subscriber

Constants

const (
	DefaultName = "mkit.broker.default"
)

Types

type Broker

type Broker interface {
	Options() Options
	NewPublisher(topic string, opts ...PublishOption) (pub Publisher, err error)
	NewSubscriber(subscription string, hdlr Handler, opts ...SubscribeOption) (sub Subscriber, err error)
	Start() error
	Shutdown() error
}

func NewBroker

func NewBroker(opts ...Option) Broker

NewBroker creates and returns a new Broker based on the packages within.

type Handler

type Handler func(context.Context, event.Event) cloudevents.Result

type Option

type Option func(*Options)

func Context

func Context(ctx context.Context) Option

Context specifies a context for the service. Can be used to signal shutdown of the service Can be used for extra option values.

func Name

func Name(n string) Option

Name of the service

type Options

type Options struct {
	Name string

	// Alternative options
	Context context.Context
}

type PublishOption

type PublishOption func(*PublishOptions)

func PublishAsync

func PublishAsync(b bool) PublishOption

func PublishContext

func PublishContext(ctx context.Context) PublishOption

PublishContext set context

type PublishOptions

type PublishOptions struct {
	// publishes msg to the topic asynchronously if set to true.
	// Default false. i.e., publishes synchronously(blocking)
	Async bool
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

type Publisher

type Publisher interface {
	Publish(ctx context.Context, event event.Event) error
	Stop()
}

type SubscribeOption

type SubscribeOption func(*SubscribeOptions)

func SubscribeContext

func SubscribeContext(ctx context.Context) SubscribeOption

SubscribeContext set context

type SubscribeOptions

type SubscribeOptions struct {
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

type Subscriber

type Subscriber interface {
	Start()
	Stop()
}