client

type LBInterface interface {
	// Init initialises the load balancing network interface.
	Init() error

	// Up attempts to bring the network interface up.
	Up() error

	// Down attempts to bring the network interface down.
	Down() error

	// AddVserver adds a Vserver to the load balancing interface.
	AddVserver(*seesaw.Vserver, seesaw.AF) error

	// Delete Vserver removes a Vserver from the load balancing interface.
	DeleteVserver(*seesaw.Vserver, seesaw.AF) error

	// AddVIP adds a VIP to the load balancing interface.
	AddVIP(*seesaw.VIP) error

	// DeleteVIP removes a VIP from the load balancing interface.
	DeleteVIP(*seesaw.VIP) error

	// AddVLAN adds a VLAN interface to the load balancing interface.
	AddVLAN(vlan *seesaw.VLAN) error

	// DeleteVLAN removes a VLAN interface from the load balancing interface.
	DeleteVLAN(vlan *seesaw.VLAN) error
}

type NCC interface {
	// NewLBInterface returns an initialised NCC network LB interface.
	NewLBInterface(name string, cfg *ncctypes.LBConfig) LBInterface

	// Dial establishes a connection to the Seesaw NCC.
	Dial() error

	// Close closes an existing connection to the Seesaw NCC.
	Close() error

	// ARPSendGratuitous sends a gratuitious ARP message.
	ARPSendGratuitous(iface string, ip net.IP) error

	// BGPConfig returns the configuration for the Quagga BGP daemon.
	BGPConfig() ([]string, error)

	// BGPNeighbors returns the neighbors that the Quagga BGP daemon
	// is peering with.
	BGPNeighbors() ([]*quagga.Neighbor, error)

	// BGPWithdrawAll requests the Quagga BGP daemon to withdraw all
	// configured network advertisements.
	BGPWithdrawAll() error

	// BGPAdvertiseVIP requests the Quagga BGP daemon to advertise the
	// specified VIP.
	BGPAdvertiseVIP(vip net.IP) error

	// BGPWithdrawVIP requests the Quagga BGP daemon to withdraw the
	// specified VIP.
	BGPWithdrawVIP(vip net.IP) error

	// IPVSFlush flushes all services and destinations from the IPVS table.
	IPVSFlush() error

	// IPVSGetServices returns all services configured in the IPVS table.
	IPVSGetServices() ([]*ipvs.Service, error)

	// IPVSGetService returns the service entry currently configured in
	// the kernel IPVS table, which matches the specified service.
	IPVSGetService(svc *ipvs.Service) (*ipvs.Service, error)

	// IPVSAddService adds the specified service to the IPVS table.
	IPVSAddService(svc *ipvs.Service) error

	// IPVSUpdateService updates the specified service in the IPVS table.
	IPVSUpdateService(svc *ipvs.Service) error

	// IPVSDeleteService deletes the specified service from the IPVS table.
	IPVSDeleteService(svc *ipvs.Service) error

	// IPVSAddDestination adds the specified destination to the IPVS table.
	IPVSAddDestination(svc *ipvs.Service, dst *ipvs.Destination) error

	// IPVSUpdateDestination updates the specified destination in
	// the IPVS table.
	IPVSUpdateDestination(svc *ipvs.Service, dst *ipvs.Destination) error

	// IPVSDeleteDestination deletes the specified destination from
	// the IPVS table.
	IPVSDeleteDestination(svc *ipvs.Service, dst *ipvs.Destination) error

	// RouteDefaultIPv4 returns the default route for IPv4 traffic.
	RouteDefaultIPv4() (net.IP, error)
}