package eventbus

Import Path
	github.com/libp2p/go-libp2p/p2p/host/eventbus (on go.dev)

Dependency Relation
	imports 12 packages, and imported by 8 packages

Involved Source Files

	    basic.go
	    basic_metrics.go
	    opts.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type MetricsTracer (interface)
		MetricsTracer tracks metrics for the eventbus subsystem

		Methods (total 6)
			( MetricsTracer) AddSubscriber(typ reflect.Type)
				AddSubscriber adds a subscriber for the event type

			( MetricsTracer) EventEmitted(typ reflect.Type)
				EventEmitted counts the total number of events grouped by event type

			( MetricsTracer) RemoveSubscriber(typ reflect.Type)
				RemoveSubscriber removes a subscriber for the event type

			( MetricsTracer) SubscriberEventQueued(name string)
				SubscriberEventQueued counts the total number of events grouped by subscriber

			( MetricsTracer) SubscriberQueueFull(name string, isFull bool)
				SubscriberQueueFull tracks whether a subscribers channel if full

			( MetricsTracer) SubscriberQueueLength(name string, n int)
				SubscriberQueueLength is the length of the subscribers channel

		As Outputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
		As Inputs Of (at least one exported)
			func WithMetricsTracer(metricsTracer MetricsTracer) Option

	 type MetricsTracerOption (func)

		As Outputs Of (at least one exported)
			func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
		As Inputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer

	 type Option (func)

		As Outputs Of (at least one exported)
			func WithMetricsTracer(metricsTracer MetricsTracer) Option
		As Inputs Of (at least one exported)
			func NewBus(opts ...Option) event.Bus


Package-Level Functions (total 7)

	 func BufSize(n int) func(interface{}) error
	 func Name(name string) func(interface{}) error
	 func NewBus(opts ...Option) event.Bus
	 func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
	 func Stateful(s interface{}) error
		Stateful is an Emitter option which makes the eventbus channel
		'remember' last event sent, and when a new subscriber joins the
		bus, the remembered event is immediately sent to the subscription
		channel.
		
		This allows to provide state tracking for dynamic systems, and/or
		allows new subscribers to verify that there are Emitters on the channel

	 func WithMetricsTracer(metricsTracer MetricsTracer) Option
	 func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption

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.