publicip

Documentation

Index

• type Fetcher
• type Logger
• type Loop
  • func NewLoop(fetcher Fetcher, logger Logger, settings settings.PublicIP, puid, pgid int) *Loop
  • func (l *Loop) ClearData() (err error)
  • func (l *Loop) GetData() (data models.PublicIP)
  • func (l *Loop) Start(_ context.Context) (_ <-chan error, err error)
  • func (l *Loop) StartSingleRun()
  • func (l *Loop) Stop() (err error)
  • func (l *Loop) String() string
  • func (l *Loop) UpdateWith(partialUpdate settings.PublicIP) (err error)

Types

type Fetcher

type Fetcher interface {
	FetchInfo(ctx context.Context, ip netip.Addr) (
		result models.PublicIP, err error)
}

type Logger

type Logger interface {
	Info(s string)
	Warn(s string)
	Error(s string)
}

type Loop

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

func NewLoop

func NewLoop(fetcher Fetcher, logger Logger,
	settings settings.PublicIP, puid, pgid int) *Loop

func (*Loop) ClearData

func (l *Loop) ClearData() (err error)

ClearData is used when the VPN connection goes down and the public IP is not known anymore.

func (*Loop) GetData

func (l *Loop) GetData() (data models.PublicIP)

GetData returns the public IP data obtained from the last fetch. It is notably used by the HTTP control server.

func (*Loop) Start

func (l *Loop) Start(_ context.Context) (_ <-chan error, err error)

func (*Loop) StartSingleRun

func (l *Loop) StartSingleRun()

func (*Loop) Stop

func (l *Loop) Stop() (err error)

func (*Loop) String

func (l *Loop) String() string

func (*Loop) UpdateWith

func (l *Loop) UpdateWith(partialUpdate settings.PublicIP) (err error)