client

type Config struct {
	Mac   net.HardwareAddr
	VLANs etherconn.VLANs

	RID       string
	CID       string
	UserName  string
	Password  string
	PPPIfName string
	// contains filtered or unexported fields
}

type DHCP6Cfg struct {
	Mac            net.HardwareAddr
	NeedPD, NeedNA bool
	Debug          bool
}

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

type DialResult struct {
	// R is the result
	R Result
	// PPPoEEP is the PPPOEEndpoint, identify the ZouPPP
	PPPoEEP *pppoe.Endpoint
	// StartTime is when dailing starts
	StartTime time.Time
	// DialFinishTime is when dailing finishes
	DialFinishTime time.Time
}

type LoggingLvl uint

type Result int

type ResultSummary struct {
	// Total is the total number of sessions
	Total uint
	// Success is the total number of sessions suceessfully finished dailup
	Success uint
	// Failed is the total number of sessions failed to finish dailup
	Failed uint
	// LessThanTenSecond is the total number of sessions suceessfully finished dailup within 10 seconds
	LessThanTenSecond uint
	// Shortest is the amount of time that fastest session finishes dialup successfully
	Shortest time.Duration
	// Longest is the amount of time that the slowest session finishes dialup successfully
	Longest time.Duration
	// SuccessTotalTime is the total amount of time of all success session finish dialup
	SuccessTotalTime time.Duration
	// TotalTime is the total amount of time of all session finish dialup
	TotalTime time.Duration
	// AvgSuccessTime is the average amount of time of a success session finish dialup
	AvgSuccessTime time.Duration
	// contains filtered or unexported fields
}

type Setup struct {

	// Ifname is the binding intereface name
	Ifname string `alias:"i" usage:"listening interface name"`
	// NumOfClients is the number of clients to be created
	NumOfClients uint `alias:"n" usage:"number of PPPoE clients"`
	// StartMAC is the starting mac address for all the sessions
	StartMAC net.HardwareAddr `alias:"mac" usage:"start MAC address"`
	// MacStep is the mac address step to increase for each session
	MacStep uint `usage:"MAC step to increase for each client"`
	// StartVLANs is the starting vlans for all the sessions
	StartVLANs etherconn.VLANs `alias:"vlan" usage:"start VLAN id, could be Dot1q or QinQ"`
	// VLANStep is the vlan step to increase for each session
	VLANStep uint `usage:"VLAN step to increase for each client"`
	// ExcludedVLANs is the slice of vlan id to skip, apply to all layer of vlans
	ExcludedVLANs []uint16 `usage:"a list of excluded VLAN id, apply to all layer of vlans"`
	// Interval is the amount of time to wait between launching each session
	Interval time.Duration `usage:"amount of time to wait between launching each session"`
	LogLevel LoggingLvl    `alias:"l" usage:"log levl, err|info|debug"`
	// if Apply is true, then create a PPP interface with assigned addresses; could be set to false if only to test protocol
	Apply bool `usage:"if Apply is true, then create a PPP interface with assigned addresses; could be set to false if only to test protocol"`
	// number of Retries
	Retry   uint          `usage:"number of setup retry"`
	Timeout time.Duration `usage:"setup timeout"`
	// AuthProto is the authenticaiton protocol to use, e.g. lcp.ProtoCHAP
	AuthProto lcp.PPPProtocolNumber `usage:"auth protocol, PAP or CHAP"`

	// RID is the BBF remote-id PPPoE tag
	RID string `usage:"BBF remote-id"`
	// CID is the BBF circuit-id PPPoE tag
	CID string `usage:"BBF circuit-id"`
	// UserName for PAP/CHAP auth
	UserName string `alias:"u" usage:"PAP/CHAP username"`
	// Password for PAP/CHAP auth
	Password string `alias:"p" usage:"PAP/CHAP password"`
	// the name of PPP interface created after successfully dialing
	PPPIfName string `usage:"name of PPP interface created after successfully dialing, must contain @ID"`
	// Run IPCP if true
	IPv4 bool `alias:"v4" usage:"run IPCP"`
	// Run IPv6CP if true
	IPv6 bool `alias:"v6" usage:"run IPv6CP"`
	// run DHCPv6 over PPP if true
	DHCPv6IANA bool `usage:"run DHCPv6 over PPP to get an IANA address"`
	DHCPv6IAPD bool `usage:"run DHCPv6 over PPP to get an IAPD prefix"`
	// enable profiling for dev
	Profiling bool `usage:"enable profiling, dev use only"`
	// use XDP to forward packet
	XDP bool `usage:"use XDP to forward packet"`
	// contains filtered or unexported fields
}

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

type ZouPPPModifier func(zou *ZouPPP)