multicast

Documentation

Index

• type GetMulticastInterfacesRequest
• type GetMulticastInterfacesResponse
• type Multicast
  • func (m *Multicast) Init(core *core.Core, nc *config.NodeConfig, log *log.Logger, options interface{}) error
  • func (m *Multicast) Interfaces() map[string]net.Interface
  • func (m *Multicast) IsStarted() bool
  • func (m *Multicast) SetupAdminHandlers(a *admin.AdminSocket)
  • func (m *Multicast) Start() error
  • func (m *Multicast) Stop() error

Types

type GetMulticastInterfacesRequest

type GetMulticastInterfacesRequest struct{}

type GetMulticastInterfacesResponse

type GetMulticastInterfacesResponse struct {
	Interfaces []string `json:"multicast_interfaces"`
}

type Multicast

type Multicast struct {
	phony.Inbox
	// contains filtered or unexported fields
}

Multicast represents the multicast advertisement and discovery mechanism used by Yggdrasil to find peers on the same subnet. When a beacon is received on a configured multicast interface, Yggdrasil will attempt to peer with that node automatically.

func (*Multicast) Init

func (m *Multicast) Init(core *core.Core, nc *config.NodeConfig, log *log.Logger, options interface{}) error

Init prepares the multicast interface for use.

func (*Multicast) Interfaces

func (m *Multicast) Interfaces() map[string]net.Interface

func (*Multicast) IsStarted

func (m *Multicast) IsStarted() bool

IsStarted returns true if the module has been started.

func (*Multicast) SetupAdminHandlers

func (m *Multicast) SetupAdminHandlers(a *admin.AdminSocket)

func (*Multicast) Start

func (m *Multicast) Start() error

Start starts the multicast interface. This launches goroutines which will listen for multicast beacons from other hosts and will advertise multicast beacons out to the network.

func (*Multicast) Stop

func (m *Multicast) Stop() error

Stop stops the multicast module.