event

Documentation

Index

• type BasicDispatcher
  • func NewDispatcher() *BasicDispatcher
  • func (dispatcher *BasicDispatcher) AddEventListener(eventType Type, handler Listener) ID
  • func (dispatcher *BasicDispatcher) DispatchEvent(event Event) bool
  • func (dispatcher *BasicDispatcher) HasEventListener(eventType Type, id ID) bool
  • func (dispatcher *BasicDispatcher) RemoveEventListener(eventType Type, id ID) bool
• type Dispatcher
• type Event
• type ID
• type Listener
  • func Listen[E Event](handler func(E)) Listener
• type Type

Types

type BasicDispatcher

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

BasicDispatcher implements a basic Dispatcher

func NewDispatcher

func NewDispatcher() *BasicDispatcher

NewDispatcher creates a BasicDispatcher

func (*BasicDispatcher) AddEventListener

func (dispatcher *BasicDispatcher) AddEventListener(eventType Type, handler Listener) ID

AddEventListener implements Dispatcher AddEventListener method

func (*BasicDispatcher) DispatchEvent

func (dispatcher *BasicDispatcher) DispatchEvent(event Event) bool

DispatchEvent implements Dispatcher DispatchEvent method

func (*BasicDispatcher) HasEventListener

func (dispatcher *BasicDispatcher) HasEventListener(eventType Type, id ID) bool

HasEventListener implements Dispatcher HasEventListener method

func (*BasicDispatcher) RemoveEventListener

func (dispatcher *BasicDispatcher) RemoveEventListener(eventType Type, id ID) bool

RemoveEventListener implements Dispatcher RemoveEventListener method

type Dispatcher

type Dispatcher interface {
	// AddEventListener registers a Listener by Type and returns the event ID
	AddEventListener(Type, Listener) ID
	// HasEventListener reports whether the Dispatcher has specified event handler
	HasEventListener(Type, ID) bool
	// RemoveEventListener removes specified event handler
	RemoveEventListener(Type, ID) bool
	// DispatchEvent dispatchs event
	DispatchEvent(Event)
}

Dispatcher represents an event dispatcher

type Event

type Event interface {
	Type() Type
}

Event is the interface that wraps the basic Type method.

type ID

type ID = int64

ID represents type of event ID

type Listener

type Listener interface {
	Listen(Event)
}

A Listener handles fired event

func Listen

func Listen[E Event](handler func(E)) Listener

Listen wraps the handler func as a Listener

type Type

type Type = string

Type represents type of event type