provider

Documentation

Index

• type Provider
• type ProviderType
  • func (pt ProviderType) String() string
• type ProxyProvider
• type RuleProvider
• type RuleType
  • func (rt RuleType) String() string
• type Vehicle
• type VehicleType
  • func (v VehicleType) String() string

Types

type Provider

type Provider interface {
	Name() string
	VehicleType() VehicleType
	Type() ProviderType
	Initial() error
	Update() error
}

Provider interface

type ProviderType

type ProviderType int

ProviderType defined

const (
	Proxy ProviderType = iota
	Rule
)

Provider Type

func (ProviderType) String

func (pt ProviderType) String() string

type ProxyProvider

type ProxyProvider interface {
	Provider
	Proxies() []constant.Proxy
	// Touch is used to inform the provider that the proxy is actually being used while getting the list of proxies.
	// Commonly used in DialContext and DialPacketConn
	Touch()
	HealthCheck()
}

ProxyProvider interface

type RuleProvider

type RuleProvider interface {
	Provider
	Behavior() RuleType
	Match(*constant.Metadata) bool
	ShouldResolveIP() bool
	AsRule(adaptor string) constant.Rule
}

RuleProvider interface

type RuleType

type RuleType int

RuleType defined

const (
	Domain RuleType = iota
	IPCIDR
	Classical
)

Rule Type

func (RuleType) String

func (rt RuleType) String() string

type Vehicle

type Vehicle interface {
	Read() ([]byte, error)
	Path() string
	Type() VehicleType
}

type VehicleType

type VehicleType int

VehicleType defined

const (
	File VehicleType = iota
	HTTP
	Compatible
)

Vehicle Type

func (VehicleType) String

func (v VehicleType) String() string