icmp

Documentation

Overview

Package icmp provides icmp enhanced methods based on the golang icmp package

Index

• Constants
• func Avg(x, y float64) float64
• func IsIPv4(ip net.IP) bool
• func IsIPv6(ip net.IP) bool
• func Max(x, y float64) float64
• func Min(x, y float64) float64
• func NormalizeDuration(d string) string
• type HopResp
• type MHopResp
  • func (h MHopResp) Len() int
  • func (h MHopResp) Less(i, j int) bool
  • func (h MHopResp) Swap(i, j int)
• type Ping
  • func NewPing(args string, cfg cli.Config) (*Ping, error)
  • func (p *Ping) DelIP(ipAddr string)
  • func (p *Ping) IsCIDR() bool
  • func (p *Ping) PacketSize(s int)
  • func (p *Ping) Ping(out chan Response)
  • func (p *Ping) PrintPretty(resp chan Response)
  • func (p *Ping) Run() chan Response
  • func (p *Ping) SetIP(ips []net.IP) error
• type Response
• type Trace
  • func NewTrace(args string) (*Trace, error)
  • func (i *Trace) Bind()
  • func (i *Trace) Done()
  • func (i *Trace) NextHop(fd, hop int) HopResp
  • func (i *Trace) PrintPretty()
  • func (i *Trace) Recv(fd int) (int, int, string)
  • func (i *Trace) Run(retry int) chan []HopResp
  • func (i *Trace) Send() error
  • func (i *Trace) SetDeadLine() error
  • func (i *Trace) SetReadDeadLine() error
  • func (i *Trace) SetTTL(ttl int)
  • func (i *Trace) SetWriteDeadLine() error
• type Whois

Constants

const (
	ProtocolIPv4ICMP = 1  // IANA ICMP for IPv4
	ProtocolIPv6ICMP = 58 // IANA ICMP for IPv6
)

IANA ICMP

const (
	// Default TX timeout
	DefaultTXTimeout int64 = 1000
	// Default RX timeout
	DefaultRXTimeout int64 = 2000
)

Functions

func Avg

func Avg(x, y float64) float64

Avg handles average delay

func IsIPv4

func IsIPv4(ip net.IP) bool

IsIPv4 returns true if ip version is v4

func IsIPv6

func IsIPv6(ip net.IP) bool

IsIPv6 returns true if ip version is v6

func Max

func Max(x, y float64) float64

Max handles maximum delay

func Min

func Min(x, y float64) float64

Min handles minimum delay

func NormalizeDuration

func NormalizeDuration(d string) string

NormalizeDuration adds default unit (seconds) as needed

Types

type HopResp

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

HopResp represents hop's response

type MHopResp

type MHopResp []HopResp

MHopResp represents multi hop's responses

func (MHopResp) Len

func (h MHopResp) Len() int

func (MHopResp) Less

func (h MHopResp) Less(i, j int) bool

func (MHopResp) Swap

func (h MHopResp) Swap(i, j int)

type Ping

type Ping struct {
	MaxRTT time.Duration
	// contains filtered or unexported fields
}

Ping represents ping request

func NewPing

func NewPing(args string, cfg cli.Config) (*Ping, error)

NewPing creates a new ping object

func (*Ping) DelIP

func (p *Ping) DelIP(ipAddr string)

DelIP removes ip adrress

func (*Ping) IsCIDR

func (p *Ping) IsCIDR() bool

IsCIDR returns true if target is CIDR

func (*Ping) PacketSize

func (p *Ping) PacketSize(s int)

PacketSize set packet size

func (*Ping) Ping

func (p *Ping) Ping(out chan Response)

Ping tries to send and receive a packet

func (*Ping) PrintPretty

func (p *Ping) PrintPretty(resp chan Response)

PrintPretty prints out the result pretty format

func (*Ping) Run

func (p *Ping) Run() chan Response

Run loops the ping and print it out

func (*Ping) SetIP

func (p *Ping) SetIP(ips []net.IP) error

SetIP set ip address

type Response

type Response struct {
	RTT      float64
	Size     int
	Sequence int
	Addr     string
	Timeout  bool
	Error    error
}

Response represent ping response

type Trace

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

Trace represents trace properties

func NewTrace

func NewTrace(args string) (*Trace, error)

NewTrace creates new trace object

func (*Trace) Bind

func (i *Trace) Bind()

Bind starts to listen for ICMP reply

func (*Trace) Done

func (i *Trace) Done()

Done close the socket

func (*Trace) NextHop

func (i *Trace) NextHop(fd, hop int) HopResp

NextHop pings the specific hop by set TTL

func (*Trace) PrintPretty

func (i *Trace) PrintPretty()

PrintPretty prints out trace result

func (*Trace) Recv

func (i *Trace) Recv(fd int) (int, int, string)

Recv gets the replied icmp packet

func (*Trace) Run

func (i *Trace) Run(retry int) chan []HopResp

Run provides trace based on the other methods

func (*Trace) Send

func (i *Trace) Send() error

Send tries to send an UDP packet

func (*Trace) SetDeadLine

func (i *Trace) SetDeadLine() error

SetDeadLine sets tx/rx timeout

func (*Trace) SetReadDeadLine

func (i *Trace) SetReadDeadLine() error

SetReadDeadLine sets rx timeout

func (*Trace) SetTTL

func (i *Trace) SetTTL(ttl int)

SetTTL set the IP packat time to live

func (*Trace) SetWriteDeadLine

func (i *Trace) SetWriteDeadLine() error

SetWriteDeadLine sets tx timeout

type Whois

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

Whois represents prefix info from RIPE