event

Documentation

Overview

Package event provides a basic API for app modules to emit events.

Index

• type Attribute
  • func NewAttribute(key, value string) Attribute
• type Event
  • func NewEvent(ty string, attrs ...Attribute) Event
• type Events
  • func NewEvents(events ...Event) Events
• type Manager
• type Service

Types

type Attribute

type Attribute = appdata.EventAttribute

Attribute is a kv-pair event attribute.

func NewAttribute

func NewAttribute(key, value string) Attribute

type Event

type Event = appdata.Event

Event defines how an event will emitted

func NewEvent

func NewEvent(ty string, attrs ...Attribute) Event

type Events

type Events = appdata.EventData

Events represents a list of events.

func NewEvents

func NewEvents(events ...Event) Events

type Manager

type Manager interface {
	// Emit emits events represented as a protobuf message (as described in ADR 032).
	//
	// Callers SHOULD assume that these events will not be included in consensus.
	Emit(event transaction.Msg) error

	// EmitKV emits an event based on an event and kv-pair attributes.
	//
	// These events will not be part of consensus and adding, removing or changing these events is
	// not a state-machine breaking change.
	EmitKV(eventType string, attrs ...Attribute) error
}

Manager represents an event manager which can emit events.

type Service

type Service interface {
	EventManager(context.Context) Manager
}

Service represents an event service which can retrieve and set an event manager in a context. event.Service is a core API type that should be provided by the runtime module being used to build an app via depinject.