mongodb

Documentation

Index

• Variables
• func NewGracefulContext(ctx context.Context, idle, forceAfter time.Duration) (c context.Context, keepAlive func(), cancel func())
• type GracefulContext
  • func (g *GracefulContext) Done() <-chan struct{}
• type Option
  • func WithCollectionName(outboxColl string) Option
  • func WithWatchToken(token string) Option
• type Outbox
  • func NewOutbox(uri, dbName string, options ...Option) (*Outbox, error)
  • func NewOutboxWithClient(client *mongo.Client, dbName string, options ...Option) (*Outbox, error)
  • func (o *Outbox) AddHandler(_ context.Context, m eh.EventMatcher, h eh.EventHandler) error
  • func (o *Outbox) Client() *mongo.Client
  • func (o *Outbox) Close() error
  • func (o *Outbox) Errors() <-chan error
  • func (o *Outbox) HandleEvent(ctx context.Context, event eh.Event) error
  • func (o *Outbox) HandlerType() eh.EventHandlerType
  • func (o *Outbox) Start()

Variables

var (
	// Interval in which to do a sweep of various unprocessed events.
	PeriodicSweepInterval = 15 * time.Second

	// Settings for how old different kind of unprocessed events needs to be
	// to be processed by the periodic sweep.
	PeriodicSweepAge   = 15 * time.Second
	PeriodicCleanupAge = 10 * time.Minute
)

Functions

func NewGracefulContext

func NewGracefulContext(ctx context.Context, idle, forceAfter time.Duration) (
	c context.Context,
	keepAlive func(),
	cancel func(),
)

NewGracefulContext will create a GracefulContext with an idle time which should be longer than a typical operation cadence, and a "force after" duration which should be long enough to let some amount of operations to finish.

Types

type GracefulContext

type GracefulContext struct {
	context.Context
	// contains filtered or unexported fields
}

GracefulContext is a context that can be gracefully cancelled after the original context has been canceled, but with a grace period to let operations finish. The KeepAlive method should be used to signal that operations are still ongoing.

func (*GracefulContext) Done

func (g *GracefulContext) Done() <-chan struct{}

Done implements the Done method of the context.Context interface.

type Option

type Option func(*Outbox) error

Option is an option setter used to configure creation.

func WithCollectionName

func WithCollectionName(outboxColl string) Option

WithCollectionName uses different collections from the default "outbox" collection.

func WithWatchToken

func WithWatchToken(token string) Option

WithWatchToken sets a token, used for watching outbox events stored with the same token. This can be used to let parts of a system watch their own events by setting a common token, for example a service name. If each host should watch their local events the hostname can often be used.

type Outbox

type Outbox struct {
	// contains filtered or unexported fields
}

Outbox implements an eventhorizon.Outbox for MongoDB.

func NewOutbox

func NewOutbox(uri, dbName string, options ...Option) (*Outbox, error)

NewOutbox creates a new Outbox with a MongoDB URI: `mongodb://hostname`.

func NewOutboxWithClient

func NewOutboxWithClient(client *mongo.Client, dbName string, options ...Option) (*Outbox, error)

NewOutboxWithClient creates a new Outbox with a client.

func (*Outbox) AddHandler

func (o *Outbox) AddHandler(_ context.Context, m eh.EventMatcher, h eh.EventHandler) error

AddHandler implements the AddHandler method of the eventhorizon.Outbox interface.

func (*Outbox) Client

func (o *Outbox) Client() *mongo.Client

Client returns the MongoDB client used by the outbox. To use the outbox with the EventStore it needs to be created with the same client.

func (*Outbox) Close

func (o *Outbox) Close() error

Close implements the Close method of the eventhorizon.EventBus interface.

func (*Outbox) Errors

func (o *Outbox) Errors() <-chan error

Errors implements the Errors method of the eventhorizon.EventBus interface.

func (*Outbox) HandleEvent

func (o *Outbox) HandleEvent(ctx context.Context, event eh.Event) error

HandleEvent implements the HandleEvent method of the eventhorizon.EventHandler interface.

func (*Outbox) HandlerType

func (o *Outbox) HandlerType() eh.EventHandlerType

HandlerType implements the HandlerType method of the eventhorizon.EventHandler interface.

func (*Outbox) Start

func (o *Outbox) Start()

Start implements the Start method of the eventhorizon.Outbox interface.