common

type BadPacketError struct {
	Err error
}

type CanceledError string

type Hop struct {
	IP       net.IP
	Port     uint16
	ICMPType uint8
	ICMPCode uint8
	RTT      time.Duration
	IsDest   bool
}

type MatcherFunc func(*ipv4.Header, []byte, net.IP, uint16, net.IP, uint16, uint32, uint16) (net.IP, error)

type MismatchError string

type ProbeResponse struct {
	// TTL is the Time To Live of the probe that was originally sent
	TTL uint8
	// IP is the IP address of the responding host
	IP netip.Addr
	// RTT is the round-trip time of the probe
	RTT time.Duration
	// IsDest is true if the responding host is the destination
	IsDest bool
}

type ReceiveProbeNoPktError struct {
	Err error
}

type Results struct {
	Source     net.IP
	SourcePort uint16
	Target     net.IP
	DstPort    uint16
	Hops       []*Hop
	Tags       []string
}

type TracerouteDriver interface {
	// GetDriverInfo returns metadata about this driver
	GetDriverInfo() TracerouteDriverInfo
	// SendProbe sends a traceroute packet with a specific TTL
	SendProbe(ttl uint8) error
	// ReceiveProbe polls to get a traceroute response with a timeout.
	ReceiveProbe(timeout time.Duration) (*ProbeResponse, error)
}

type TracerouteDriverInfo struct {
	SupportsParallel bool
}

type TracerouteParallelParams struct {
	TracerouteParams
}

type TracerouteParams struct {
	// MinTTL is the TTL to start the traceroute at
	MinTTL uint8
	// MaxTTL is the TTL to end the traceroute at
	MaxTTL uint8
	// TracerouteTimeout is the maximum time to wait for a response
	TracerouteTimeout time.Duration
	// PollFrequency is how often to poll for a response
	PollFrequency time.Duration
	// SendDelay is the delay between sending probes (typically small)
	SendDelay time.Duration
}

type TracerouteSerialParams struct {
	TracerouteParams
}