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() uintdeprecated
- 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)deprecated
- type EventEmitter
- type EventName
- type Events
- type Listener
Examples ¶
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 // // Deprecated: No longer limit the number of event listeners. DefaultMaxListeners = types.EventDefaultMaxListeners )
Variables ¶
This section is empty.
Functions ¶
func AddListener ¶ added in v2.4.0
AddListener adds listeners to the default event emitter
func GetMaxListeners
deprecated
added in
v2.4.0
func GetMaxListeners() uint
GetMaxListeners returns the max listeners for the default event emitter
Deprecated: No longer limit the number of event listeners.
func Len ¶ added in v2.4.0
func Len() int
Len returns the total number of events currently registered
func ListenerCount ¶ added in v2.4.0
ListenerCount returns the number of listeners for an event
func RemoveAllListeners ¶ added in v2.4.0
RemoveAllListeners removes all listeners for an event
func RemoveListener ¶ added in v2.4.0
RemoveListener removes a listener from the event emitter
func SetMaxListeners
deprecated
added in
v2.4.0
func SetMaxListeners(n uint)
SetMaxListeners sets the max listeners for the default event emitter
Deprecated: No longer limit the number of event listeners.
Types ¶
type EventEmitter ¶
type EventEmitter = types.EventEmitter
EventEmitter is the message/or/event manager
type EventName ¶
EventName is just a type of string, it's the event name
func EventNames ¶ added in v2.4.0
func EventNames() []EventName
EventNames returns all the event names
type 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
Source Files