eventbus

Documentation

Index

• Variables
• func Publish(e localEvent)
• func Subscribe() pubsub.Subscription
• type Eventbus
  • func New() Eventbus
• type NetworkAddressAdded
• type NetworkAddressRemoved
• type ObjectPinned
• type ObjectUnpinned
• type PeerConnectionEstablished
• type RelayAdded
• type RelayRemoved

Variables

var (
	// DefaultEventbus -
	DefaultEventbus = New()
)

Functions

func Publish

func Publish(e localEvent)

Publish a local event in the Default eventbus

func Subscribe

func Subscribe() pubsub.Subscription

Subscribe to all local events on the default eventbus

Types

type Eventbus

type Eventbus interface {
	Publish(localEvent)
	Subscribe() pubsub.Subscription
}

Eventbus for passing information around the various nimona packages.

func New

func New() Eventbus

New constructs a new event bus

type NetworkAddressAdded

type NetworkAddressAdded struct {
	Address string
	// contains filtered or unexported fields
}

NetworkAddressAdded is published when the network starts listening to a new address.

type NetworkAddressRemoved

type NetworkAddressRemoved struct {
	Address string
	// contains filtered or unexported fields
}

NetworkAddressRemoved is published when the network stops listening to an existing address.

type ObjectPinned

type ObjectPinned struct {
	Hash object.Hash
	// contains filtered or unexported fields
}

ObjectPinned is published when an object is pinned.

type ObjectUnpinned

type ObjectUnpinned struct {
	Hash object.Hash
	// contains filtered or unexported fields
}

ObjectUnpinned is published when an object is unpinned.

type PeerConnectionEstablished

type PeerConnectionEstablished struct {
	PublicKey crypto.PublicKey
	// contains filtered or unexported fields
}

PeerConnectionEstablished is published when a connection is established with a peer.

type RelayAdded

type RelayAdded struct {
	Peer *peer.Peer
	// contains filtered or unexported fields
}

RelayAdded is published when a relay has been found and should be used.

type RelayRemoved

type RelayRemoved struct {
	PublicKey crypto.PublicKey
	// contains filtered or unexported fields
}

RelayRemoved is published when a relay should be removed.