event

Documentation

Index

• type Dispatcher
• type Event
• type Listener
  • func Listen[T comparable, E Event[T]](eventType T, handler func(E)) Listener[T]
• type ListenerID

Types

type Dispatcher

type Dispatcher[T comparable] interface {
	// AddEventListener registers a Listener and returns the listener ID
	AddEventListener(Listener[T]) ListenerID
	// HasEventListener reports whether the Dispatcher has specified event handler
	HasEventListener(ListenerID) bool
	// RemoveEventListener removes specified event handler
	RemoveEventListener(ListenerID) bool
	// DispatchEvent dispatchs event
	DispatchEvent(Event[T]) bool
}

Dispatcher represents an event dispatcher

type Event

type Event[T comparable] interface {
	Type() T // Type gets type of event
}

Event is the interface that wraps the basic Type method.

type Listener

type Listener[T comparable] interface {
	EventType() T    // EventType gets type of listening event
	Handle(Event[T]) // Handle handles fired event
}

A Listener handles fired event

func Listen

func Listen[T comparable, E Event[T]](eventType T, handler func(E)) Listener[T]

Listen creates a Listener by eventType and handler function

type ListenerID

type ListenerID = int64

ListenerID represents an event listener ID