pinger

Documentation

Index

• Variables
• type PingEvent
• type PingEventBad
• type PingEventDestroy
• type PingEventError
• type PingEventGood
• type PingOptions
• type Pinger
• type WindowsIcmpPinger
  • func (w *WindowsIcmpPinger) Destroy()
  • func (w *WindowsIcmpPinger) Init(destination string, events chan PingEvent, options PingOptions)
  • func (w *WindowsIcmpPinger) Start()

Variables

var DefaultPingOptions = PingOptions{
	StopOnGood:   false,
	StopOnBad:    false,
	StopOnChange: false,
	Timeout:      2 * time.Second,
}

Types

type PingEvent

type PingEvent struct {
	Timestamp   time.Time         `json:"timestamp"`
	Destination string            `json:"destination"`
	ExtraInfo   string            `json:"extra_info,omitempty"`
	Error       *PingEventError   `json:"error,omitempty"`
	Good        *PingEventGood    `json:"good,omitempty"`
	Bad         *PingEventBad     `json:"bad,omitempty"`
	Destroy     *PingEventDestroy `json:"destroy,omitempty"`
}

type PingEventBad

type PingEventBad struct {
	LastGood time.Time `json:"last_good,omitempty"`
}

type PingEventDestroy

type PingEventDestroy struct{}

type PingEventError

type PingEventError struct {
	Message string `json:"message"`
}

type PingEventGood

type PingEventGood struct {
	LastBad time.Time     `json:"last_bad,omitempty"`
	RTT     time.Duration `json:"rtt"`
}

type PingOptions

type PingOptions struct {
	StopOnGood   bool
	StopOnBad    bool
	StopOnChange bool
	Timeout      time.Duration
}

type Pinger

type Pinger interface {
	Init(destination string, events chan PingEvent, options PingOptions)
	Start()
	Destroy()
}

type WindowsIcmpPinger

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

func (*WindowsIcmpPinger) Destroy

func (w *WindowsIcmpPinger) Destroy()

func (*WindowsIcmpPinger) Init

func (w *WindowsIcmpPinger) Init(destination string, events chan PingEvent, options PingOptions)

func (*WindowsIcmpPinger) Start

func (w *WindowsIcmpPinger) Start()