cmd

Documentation

Overview

Package cmd contains command implementations

Index

• Constants
• Variables
• func GetVersion(print bool) (txt string)
• func HasFlag() bool
• func InitFlag()
• func InitLog()
• func IsFlagPassed(name string) bool
• func IsPrivateIPv4(s string) bool
• func IsPrivateIPv6(s string) bool
• func IsValidIP(s string) bool
• func LogHttping(stats httping.Stats, err error, address string)
• func LogMtr(hops []mtr.Hops)
• func LogPing(dst *net.IPAddr, dur time.Duration, err error)
• func LogQuery(info IPInfo)
• func LogTcping(code int, address string)
• func LookupIP(s string) string
• func ParseInput(s string) string
• type IPInfo
  • func QueryInfo(address string) IPInfo

Constants

const (
	// API is the URL of ifconfig network info API
	API string = "https://ifconfig.is/json/"
)

Variables

var (
	// Name is the name of the program
	Name = "tcping"
	// Version is the version of the program
	Version = "- not set -"
	// Commit is the commit of the build
	Commit = "snapshot"
	// Date is the date of the build
	Date = ""
)

var CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)

CommandLine is the flag command line

var HTTPingDst string

HTTPingDst is the HTTP Ping URL

var Logger = logrus.New()

Logger is the global logger

var MtrDst string

MtrDst is the MTR Trace Address

var PingDst string

PingDst is the ICMP Ping Address

var Query string

Query is the Query IP Address

var TCPingDst string

TCPingDst is the TCP Ping Address

var Usage = func() {
	_, _ = fmt.Fprintf(CommandLine.Output(), "Usage:\n")
	flag.PrintDefaults()
}

Usage prints the usage

var VersionFlg bool

VersionFlg is the version flag

Functions

func GetVersion

func GetVersion(print bool) (txt string)

GetVersion extract compiled version info

func HasFlag

func HasFlag() bool

HasFlag checks if any flag is passed

func InitFlag

func InitFlag()

InitFlag initializes the flags

func InitLog

func InitLog()

InitLog initializes the logger

func IsFlagPassed

func IsFlagPassed(name string) bool

IsFlagPassed checks if a specific flag is passed

func IsPrivateIPv4

func IsPrivateIPv4(s string) bool

IsPrivateIPv4 checks if the input string is a private IPv4 address

func IsPrivateIPv6

func IsPrivateIPv6(s string) bool

IsPrivateIPv6 checks if the input string is a private IPv6 address

func IsValidIP

func IsValidIP(s string) bool

IsValidIP checks if the input string is a valid IP address

func LogHttping

func LogHttping(stats httping.Stats, err error, address string)

LogHttping logs the httping results

func LogMtr

func LogMtr(hops []mtr.Hops)

LogMtr logs the mtr results

func LogPing

func LogPing(dst *net.IPAddr, dur time.Duration, err error)

LogPing logs the ping results

func LogQuery

func LogQuery(info IPInfo)

LogQuery logs the query results

func LogTcping

func LogTcping(code int, address string)

LogTcping logs the tcping results

func LookupIP

func LookupIP(s string) string

LookupIP looks up the IP address of a hostname

func ParseInput

func ParseInput(s string) string

ParseInput parses the input string

Types

type IPInfo

type IPInfo struct {
	Continent string  `json:"Continent"`
	Country   string  `json:"Country"`
	City      string  `json:"City"`
	Latitude  float64 `json:"Latitude"`
	Longitude float64 `json:"Longitude"`
	TimeZone  string  `json:"TimeZone"`
	ASN       uint    `json:"ASN"`
	ORG       string  `json:"Organization"`
}

IPInfo is the struct of IP information

func QueryInfo

func QueryInfo(address string) IPInfo

QueryInfo queries the IP information