events

package module

v0.1.5 Latest Latest Go to latest Published: Oct 8, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.phalacee.com/kiss-my-package/events-go

Links

Open Source Insights

README ¶

-events-go

-events-go is part of the kiss-my-package set used by apps like FaceMasq, PaperBag, Celestial, Executrix, and more

Documentation ¶

Index ¶

Constants
func Emit(ctx context.Context, e Event) error
func EmitError(ctx context.Context, kind string, err error, payload interface{}) error
func EmitPayload(ctx context.Context, kind string, payload interface{}) error
func List() ([]string, error)
func SetManager(custom Manager)
type DeleteFn
- func Listen(l Listener) (DeleteFn, error)
- func NamedListen(name string, l Listener) (DeleteFn, error)
type Event
type Listener
- func Filter(ctx context.Context, match string, original Listener) Listener
type Manager
- func DefaultManager() Manager
type Payload

Constants ¶

View Source

const (
	// ErrGeneral is emitted for general errors.
	ErrGeneral = "general:err"
	// ErrPanic is emitted when a panic is recovered.
	ErrPanic = "panic:err"
)

Variables ¶

This section is empty.

Functions ¶

func Emit ¶

func Emit(ctx context.Context, e Event) error

Emit an event to all listeners.

func EmitError ¶

func EmitError(ctx context.Context, kind string, err error, payload interface{}) error

func EmitPayload ¶

func EmitPayload(ctx context.Context, kind string, payload interface{}) error

func List ¶

func List() ([]string, error)

List all listeners.

func SetManager ¶

func SetManager(custom Manager)

SetManager allows you to replace the default event manager with a custom one.

Types ¶

type DeleteFn ¶

type DeleteFn func()

func Listen ¶

func Listen(l Listener) (DeleteFn, error)

Listen for events.

func NamedListen ¶

func NamedListen(name string, l Listener) (DeleteFn, error)

NamedListen for events. Name is the name of the listener NOT the events you want to listen for, so something like "my-listener", "kafka-listener", etc...

type Event ¶

type Event struct {
	// Kind is the "type" of event "app:start".
	Kind string `json:"kind"`
	// Message is optional.
	Message string `json:"message"`
	// Payload is optional.
	Payload Payload `json:"payload"`
	// Error is optional.
	Error error `json:"-"`
}

Event represents different events in the lifecycle of a Buffalo app.

func (Event) IsError ¶

func (e Event) IsError() bool

func (Event) MarshalJSON ¶

func (e Event) MarshalJSON() ([]byte, error)

MarshalJSON implements the json marshaler for an event.

func (Event) String ¶

func (e Event) String() string

func (Event) Validate ¶

func (e Event) Validate() error

Validate that an event is ready to be emitted.

type Listener ¶

type Listener func(ctx context.Context, e Event) error

Listener is a function capable of handling events.

func Filter ¶

func Filter(ctx context.Context, match string, original Listener) Listener

Filter compiles the string as a regex and returns the original listener (lstnr) wrapped in a new listener that filters incoming events by the Kind.

type Manager ¶

type Manager interface {
	Listen(string, Listener) (DeleteFn, error)
	Emit(context.Context, Event) error
	List() ([]string, error)
	Listeners() *listenerMap
}

Manager can be implemented to replace the default events manager.

func DefaultManager ¶

func DefaultManager() Manager

DefaultManager implements a map backed Manager.

type Payload ¶

type Payload = mapi.Mapi

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mapi
safe

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL