patrol

Documentation

Index

• Constants
• func CheckHTTPSConnection(ctx context.Context, network, domain string) (statusCode int, err error)
• func HTTPSConnectivityConfirmed() bool
• type Patrol
  • func New(instance instance) (*Patrol, error)
  • func (p *Patrol) Manager() *mgr.Manager
  • func (p *Patrol) Start() error
  • func (p *Patrol) Stop() error

Constants

const ChangeSignalEventName = "change signal"

ChangeSignalEventName is the name of the event that signals any change in the patrol system.

Functions

func CheckHTTPSConnection

func CheckHTTPSConnection(ctx context.Context, network, domain string) (statusCode int, err error)

CheckHTTPSConnection checks if a HTTPS connection to the given domain can be established.

func HTTPSConnectivityConfirmed

func HTTPSConnectivityConfirmed() bool

HTTPSConnectivityConfirmed returns whether the last HTTPS connectivity check succeeded. Is "true" before first test.

Types

type Patrol

type Patrol struct {
	EventChangeSignal *mgr.EventMgr[struct{}]
	// contains filtered or unexported fields
}

func New

func New(instance instance) (*Patrol, error)

New returns a new Config module.

func (*Patrol) Manager

func (p *Patrol) Manager() *mgr.Manager

func (*Patrol) Start

func (p *Patrol) Start() error

func (*Patrol) Stop

func (p *Patrol) Stop() error