icmp

Documentation

Overview

Package icmp sends and receives icmp echo request/reply packets over a UDP socket. Both IPv4 and IPv6 are supported.

A process using this package can only have one Socket instance.

Index

• type Response
  • func (r Response) LogValue() slog.Value
  • func (r Response) SequenceNumber() SequenceNumber
• type SequenceNumber
• type Socket
  • func New(tp Transport, l *slog.Logger) *Socket
  • func (s *Socket) Ping(ip net.IP, seq SequenceNumber, ttl uint8, payload []byte) error
  • func (s *Socket) Read(ctx context.Context) (Response, error)
  • func (s *Socket) Resolve(host string) (net.IP, error)
  • func (s *Socket) Serve(ctx context.Context)
• type Transport
  • func (tp Transport) String() string

Types

type Response

type Response struct {
	From     net.IP
	MsgType  icmp.Type
	Body     icmp.MessageBody
	Received time.Time
}

func (Response) LogValue

func (r Response) LogValue() slog.Value

func (Response) SequenceNumber

func (r Response) SequenceNumber() SequenceNumber

type SequenceNumber

type SequenceNumber uint16

type Socket

type Socket struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

func New

func New(tp Transport, l *slog.Logger) *Socket

func (*Socket) Ping

func (s *Socket) Ping(ip net.IP, seq SequenceNumber, ttl uint8, payload []byte) error

func (*Socket) Read

func (s *Socket) Read(ctx context.Context) (Response, error)

func (*Socket) Resolve

func (s *Socket) Resolve(host string) (net.IP, error)

func (*Socket) Serve

func (s *Socket) Serve(ctx context.Context)

type Transport

type Transport int

const (
	IPv4 Transport = 0x01
	IPv6 Transport = 0x02
)

func (Transport) String

func (tp Transport) String() string