package hub

Import Path
	github.com/cenkalti/hub (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	  d hub.go
		Package hub provides a simple event dispatcher for publish/subscribe pattern.
Code Examples

	
		package main
		
		import (
			"fmt"
		
			"github.com/cenkalti/hub"
		)
		
		// Different event kinds
		const (
			happenedA hub.Kind = iota
			happenedB
			happenedC
		)
		
		// Our custom event type
		type EventA struct {
			arg1, arg2 int
		}
		
		// Implement hub.Event interface
		func (e EventA) Kind() hub.Kind { return happenedA }
		
		func main() {
			hub.Subscribe(happenedA, func(e hub.Event) {
				a := e.(EventA) // Cast to concrete type
				fmt.Println(a.arg1 + a.arg2)
			})
		
			hub.Publish(EventA{2, 3})
		}


Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Event (interface)
		Event is an interface for published events.

		Methods (only one)
			( Event) Kind() Kind
		As Inputs Of (at least 2)
			func Publish(e Event)
			func (*Hub).Publish(e Event)

	 type Hub (struct)
		Hub is an event dispatcher, publishes events to the subscribers
		which are subscribed for a specific event type.
		Optimized for publish calls.
		The handlers may be called in order different than they are registered.

		Methods (total 2)
			(*Hub) Publish(e Event)
				Publish an event to the subscribers.

			(*Hub) Subscribe(kind Kind, f func(Event)) (cancel func())
				Subscribe registers f for the event of a specific kind.

		As Types Of (only one)
			  var DefaultHub

	 type Kind int (basic type)

		As Outputs Of (at least one exported)
			func Event.Kind() Kind
		As Inputs Of (at least 2)
			func Subscribe(kind Kind, f func(Event)) (cancel func())
			func (*Hub).Subscribe(kind Kind, f func(Event)) (cancel func())


Package-Level Functions (total 2)

	 func Publish(e Event)
		Publish an event to the subscribers in DefaultHub.

	 func Subscribe(kind Kind, f func(Event)) (cancel func())
		Subscribe registers f for the event of a specific kind in the DefaultHub.


Package-Level Variables (only one)

	  var DefaultHub Hub
		DefaultHub is the default Hub used by Publish and Subscribe.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.