eventmanager

package module
v0.0.0-...-4b12fc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 16, 2024 License: AGPL-3.0 Imports: 1 Imported by: 0

README

Event Manager for Go - Simple and Flexible Event Handling

Overview

This is a simple event manager module written in Go. It allows you to manage events and their handlers, providing functionalities to add, remove, and trigger events.

Installation

To use this module in your Go project, you can install it using the following command:

go get -u github.com/NIR3X/eventmanager

Usage

Here's a basic example demonstrating how to use the event manager:

package main

import (
	"fmt"
	"github.com/NIR3X/eventmanager"
)

func main() {
	// Create a new EventManager instance.
	em := eventmanager.NewEventManager()

	// Add an event handler for "example_event".
	handlerId := em.AddHandler("example_event", func(data interface{}) {
		fmt.Printf("Received event: example_event, Data: %v\n", data)
	})

	// Trigger the "example_event" event.
	em.TriggerEvent("example_event", "Hello, world!")

	// Remove the event handler using the handler Id.
	em.RemoveHandler("example_event", handlerId)

	// Trigger the event again to verify removal.
	em.TriggerEvent("example_event", "Hello again!")
}

License

GNU AGPLv3 Image

This program is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EventHandler

type EventHandler func(interface{})

EventHandler represents a function that handles events.

type EventManager

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

EventManager manages events and their handlers.

func NewEventManager

func NewEventManager() *EventManager

NewEventManager creates a new instance of EventManager.

func (*EventManager) AddHandler

func (em *EventManager) AddHandler(event string, handler EventHandler) int64

AddHandler adds an event handler for the specified event and returns the handler Id.

func (*EventManager) RemoveHandler

func (em *EventManager) RemoveHandler(event string, handlerId int64)

RemoveHandler removes an event handler for the specified event and handler Id.

func (*EventManager) TriggerEvent

func (em *EventManager) TriggerEvent(event string, data interface{})

TriggerEvent triggers the specified event with the given data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL