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 ...EventListener) error
- func Clear()
- func Emit(evt EventName, data ...any)
- func Len() int
- func ListenerCount(evt EventName) int
- func On(evt EventName, listeners ...EventListener) error
- func Once(evt EventName, listeners ...EventListener) error
- func RemoveAllListeners(evt EventName) bool
- func RemoveListener(evt EventName, listener EventListener) bool
- type EventEmitter
- type EventListener
- type EventName
- type Events
Examples ¶
Constants ¶
View Source
const ( // Version current version number EventVersion = types.EventVersion )
Variables ¶
This section is empty.
Functions ¶
func AddListener ¶
func AddListener(evt EventName, listeners ...EventListener) error
AddListener adds listeners to the default event emitter
func ListenerCount ¶
ListenerCount returns the number of listeners for an event
func Once ¶
func Once(evt EventName, listeners ...EventListener) error
Once adds a one-time listener to the event emitter
func RemoveAllListeners ¶
RemoveAllListeners removes all listeners for an event
func RemoveListener ¶
func RemoveListener(evt EventName, listener EventListener) bool
RemoveListener removes a listener from the event emitter
Types ¶
type EventEmitter ¶
type EventEmitter = types.EventEmitter
EventEmitter is the message/or/event manager
type EventListener ¶
type EventListener = types.EventListener
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) []EventListener
Listeners returns all the listeners for an event
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
Click to show internal directories.
Click to hide internal directories.