goevent

README

goevent

goevent is event dispatcher written by golang.

example

listen for event

e := goevent.New()
e.On(func(i int, s string){
  fmt.Printf("%d: %s\n", i, s)
})

Trigger

e.Trigger(1, "foo")

Use event table

table := goevent.NewTable()
table.On("foo", func(i int){
  fmt.Printf("foo: %d\n", i)
})
table.On("bar", func(s string){
  fmt.Printf("bar: %s\n", s)
})

table.Trigger("foo", 1)
table.Trigger("bar", "hoge")
table.Trigger("bar", 38)    // retrun error

LICENSE

Copyright © 2015 pocke Licensed [MIT][mit] [MIT]: http://www.opensource.org/licenses/mit-license.php

Documentation

Overview

Package goevent is event dispatcher.

Listen for event:

e := goevent.New()
e.On(func(i int, s string){
  fmt.Printf("%d: %s\n", i, s)
})

Trigger:

e.Trigger(1, "foo")

Use event table:

table := goevent.NewTable()
table.On("foo", func(i int){
  fmt.Printf("foo: %d\n", i)
})
table.On("bar", func(s string){
  fmt.Printf("bar: %s\n", s)
})

table.Trigger("foo", 1)
table.Trigger("bar", "hoge")
table.Trigger("bar", 38)    // retrun error

Index

• type Event
  • func New() Event
• type EventNotDefined
  • func (e *EventNotDefined) Error() string
  • func (e *EventNotDefined) EventName() string
• type Table
  • func NewTable() Table

Types

type Event

type Event interface {
	Trigger(args ...interface{}) error
	// f is a function
	On(f interface{}) error
	Off(f interface{}) error
}

Event is an event.

func New

func New() Event

New creates a new event.

type EventNotDefined

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

EventNotDefined is an error indicationg that the event has not been defined.

func (*EventNotDefined) Error

func (e *EventNotDefined) Error() string

func (*EventNotDefined) EventName

func (e *EventNotDefined) EventName() string

EventName return name of the event.

type Table

type Table interface {
	Trigger(name string, args ...interface{}) error
	// f is a function
	On(name string, f interface{}) error
	Off(name string, f interface{}) error
	// Destroy a event
	Destroy(name string) error
}

Table is an event table.

func NewTable

func NewTable() Table

NewTable creates a new event table.