ping

Documentation

Index

• Constants
• func Room(ctx context.Context, roomID string, config Config, log *zap.SugaredLogger) (map[string]*Result, *nerr.E)
• type Config
• type Host
• type Pinger
  • func NewPinger() (*Pinger, error)
  • func (p *Pinger) Close()
  • func (p *Pinger) Ping(ctx context.Context, config Config, hosts ...Host) map[string]*Result
• type Result

Constants

const (
	// ICMPProtocol .
	ICMPProtocol = 1

	// ICMP6Protocol .
	ICMP6Protocol = 58
)

Functions

func Room

func Room(ctx context.Context, roomID string, config Config, log *zap.SugaredLogger) (map[string]*Result, *nerr.E)

Room pings the room and returns the results

Types

type Config

type Config struct {
	Count int           // the number of pings to send
	Delay time.Duration // the delay after sending a ping before sending the next
}

Config .

type Host

type Host struct {
	ID   string
	Addr string
}

Host .

type Pinger

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

Pinger .

func NewPinger

func NewPinger() (*Pinger, error)

NewPinger .

func (*Pinger) Close

func (p *Pinger) Close()

Close .

func (*Pinger) Ping

func (p *Pinger) Ping(ctx context.Context, config Config, hosts ...Host) map[string]*Result

Ping .

type Result

type Result struct {
	Error string `json:"error,omitempty"`

	IP               net.IP `json:"ip,omitempty"`
	PacketsSent      int    `json:"packets-sent,omitempty"`
	PacketsReceived  int    `json:"packets-received,omitempty"`
	PacketsLost      int    `json:"packets-lost,omitempty"`
	AverageRoundTrip string `json:"average-round-trip,omitempty"`
}

Result .