pinger

package module

v0.4.3 Latest Latest Go to latest Published: Jun 17, 2024 License: MPL-2.0 Imports: 18 Imported by: 1

Details

A cross platform unprivileged Ping (ICMP Echo) library for Go.

And other platforms with the ping command available.

This section is empty.

This section is empty.

This section is empty.

type Option func(*Pinger)

Option is a configuration function for Pinger.

func WithLogger(logger *slog.Logger) Option

WithLogger provides a logger to use for logging.

func WithMaxChildProcesses(n int) Option

WithMaxChildProcesses sets the maximum number of ping commands that can be run concurrently. This helps avoid an easy DoS target.

func WithPacketConnFactory(factory PacketConnFactory) Option

WithPacketConnFactory allows the use of a custom PacketConnFactory.

func WithResolver(r resolver.Resolver) Option

WithResolver provides a DNS Resolver to use for resolving hostnames.

type PacketConnFactory func(network string) (net.PacketConn, error)

PacketConnFactory is a factory function for creating ICMP PacketConns. Known networks are "ip", "ip4", and "ip6".

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

Pinger sends ICMP echo requests to hosts.

func New(opts ...Option) *Pinger

New creates a new Pinger.

func (p *Pinger) Ping(ctx context.Context, network, host string) error

Ping sends an ICMP echo request to the specified host. Known networks are "ip", "ip4", and "ip6".