connection

package

v1.0.1 Latest Latest Go to latest Published: Aug 27, 2026 License: GPL-3.0 Imports: 13 Imported by: 0

Details

Package connection owns the active session and drives an engine.Engine

This section is empty.

This section is empty.

This section is empty.

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

func New(dir string, st store.Disk, newEngine engine.New, probe engine.Probe, logger *log.Logger) *Service

func (s *Service) ActiveID() (string, error)

ActiveID returns the connected node id, or the last one used, or "" if none.

func (s *Service) Connect(id string) (Status, error)

func (s *Service) Disconnect() (Status, error)

func (s *Service) ForgetIfRemoved(subID string, nodes []domain.Node)

ForgetIfRemoved drops the active node when its subscription is deleted.

func (s *Service) Nodes() ([]rpc.Node, error)

func (s *Service) Probe(sub, id string) ([]rpc.Node, error)

Probe pings one node if id is set, else every node in sub, else all of them.

func (s *Service) RefreshEvery() int

RefreshEvery is the subscription refresh interval in hours, 0 when off.

func (s *Service) Restore()

func (s *Service) SetSettings(in domain.Settings) (Status, error)

func (s *Service) SetTun(enable bool) (Status, error)

func (s *Service) Settings() domain.Settings

func (s *Service) Shutdown()

Shutdown tears the active engine down without broadcasting, for process exit.

func (s *Service) Status() Status

func (s *Service) Watch() (initial Status, ch <-chan Status, cancel func())

Watch registers a status subscriber

type Status = rpc.Status