connectivity

README

connectivity

See example usage in ./examples.

Documentation

Overview

Package connectivity provides primitives for recording one's internet connectivity.

Index

• type Kind
• type Option
  • func WithProbe(probe Probe) Option
  • func WithProbeInterval(d time.Duration) Option
  • func WithProbeTimeout(d time.Duration) Option
• type Probe
• type Recorder
  • func NewRecorder(opts ...Option) *Recorder
  • func (c *Recorder) Spans() []Span
  • func (c *Recorder) Stop()
• type Span
  • func (s *Span) Duration() time.Duration

Types

type Kind

type Kind int

Kind represents a span kind.

const (
	Offline Kind = iota
	Online
)

Kinds of connectivity spans.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures a recorder instance.

func WithProbe

func WithProbe(probe Probe) Option

WithProbe configuress the used connectivity probe.

func WithProbeInterval

func WithProbeInterval(d time.Duration) Option

WithProbeInterval configures the duration between consecutive connectivity probes.

func WithProbeTimeout

func WithProbeTimeout(d time.Duration) Option

WithProbeTimeout configures the timeout for individual connectivity probes.

type Probe

type Probe func(context.Context) error

Probe represents a connectivity probe.

type Recorder

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

Recorder records one's connectivity.

func NewRecorder

func NewRecorder(opts ...Option) *Recorder

NewRecorder returns new connectivity recorder.

func (*Recorder) Spans

func (c *Recorder) Spans() []Span

Spans returns all recorded connectivity spans.

func (*Recorder) Stop

func (c *Recorder) Stop()

Stop stops recording.

type Span

type Span struct {
	Kind      Kind // Offline or Online span.
	StartTime time.Time
	EndTime   time.Time
}

Span describes one's connectivity for a time period.

func (*Span) Duration

func (s *Span) Duration() time.Duration

Duration returns the duration of the span.