events

Documentation

Overview

Source: https://github.com/kataras/go-events Package events provides simple EventEmitter support for Go Programming Language

Index

• Constants
• func AddListener(evt EventName, listeners ...Listener) error
• func Clear()
• func Emit(evt EventName, data ...any)
• func GetMaxListeners() uint
• func Len() int
• func ListenerCount(evt EventName) int
• func On(evt EventName, listeners ...Listener) error
• func Once(evt EventName, listeners ...Listener) error
• func RemoveAllListeners(evt EventName) bool
• func RemoveListener(evt EventName, listener Listener) bool
• func SetMaxListeners(n uint)
• type EventEmitter
  • func New() EventEmitter
• type EventName
  • func EventNames() []EventName
• type Events
• type Listener
  • func Listeners(evt EventName) []Listener

Examples

• Events

Constants

const (
	// Version current version number
	Version = types.EventVersion

	// DefaultMaxListeners is the number of max listeners per event
	// default EventEmitters will print a warning if more than x listeners are
	// added to it. This is a useful default which helps finding memory leaks.
	// Defaults to 0, which means unlimited
	DefaultMaxListeners = types.EventDefaultMaxListeners
)

Functions

func AddListener

func AddListener(evt EventName, listeners ...Listener) error

AddListener adds listeners to the default event emitter

func Clear

func Clear()

Clear removes all listeners and events

func Emit

func Emit(evt EventName, data ...any)

Emit triggers an event on the default event emitter

func GetMaxListeners

func GetMaxListeners() uint

GetMaxListeners returns the max listeners for the default event emitter

func Len

func Len() int

Len returns the total number of events currently registered

func ListenerCount

func ListenerCount(evt EventName) int

ListenerCount returns the number of listeners for an event

func On

func On(evt EventName, listeners ...Listener) error

On is an alias for AddListener

func Once

func Once(evt EventName, listeners ...Listener) error

Once adds a one-time listener to the event emitter

func RemoveAllListeners

func RemoveAllListeners(evt EventName) bool

RemoveAllListeners removes all listeners for an event

func RemoveListener

func RemoveListener(evt EventName, listener Listener) bool

RemoveListener removes a listener from the event emitter

func SetMaxListeners

func SetMaxListeners(n uint)

SetMaxListeners sets the max listeners for the default event emitter

Types

type EventEmitter

type EventEmitter = types.EventEmitter

EventEmitter is the message/or/event manager

func New

func New() EventEmitter

New returns a new, empty, EventEmitter

type EventName

type EventName = types.EventName

EventName is just a type of string, it's the event name

func EventNames

func EventNames() []EventName

EventNames returns all the event names

type Events

type Events = types.Events

Events the type for registered listeners, it's just a map[string][]func(...any)

Example

// regiter our events to the default event emmiter
for evt, listeners := range testEvents {
	_event.On(evt, listeners...)
}

user := "user1"
room := "room1"

createUser(user)
joinUserTo(user, room)
leaveFromRoom(user, room)

Output:

A new User just created!
A new User just created, *from second event listener
user1 joined to room: room1
user1 left from the room: room1

type Listener

type Listener = types.Listener

Listener is the type of a Listener, it's a func which receives any,optional, arguments from the caller/emmiter

func Listeners

func Listeners(evt EventName) []Listener

Listeners returns all the listeners for an event