provider

Documentation

Index

• Constants
• type CompatibleProvider
  • func NewCompatibleProvider(name string, proxies []C.Proxy, hc *HealthCheck) (*CompatibleProvider, error)
  • func (cp CompatibleProvider) HealthCheck()
  • func (cp CompatibleProvider) Initial() error
  • func (cp CompatibleProvider) MarshalJSON() ([]byte, error)
  • func (cp CompatibleProvider) Name() string
  • func (cp CompatibleProvider) Proxies() []C.Proxy
  • func (cp CompatibleProvider) ProxiesWithTouch() []C.Proxy
  • func (cp CompatibleProvider) Type() ProviderType
  • func (cp CompatibleProvider) Update() error
  • func (cp CompatibleProvider) VehicleType() VehicleType
• type FileVehicle
  • func NewFileVehicle(path string) *FileVehicle
  • func (f *FileVehicle) Path() string
  • func (f *FileVehicle) Read() ([]byte, error)
  • func (f *FileVehicle) Type() VehicleType
• type HTTPVehicle
  • func NewHTTPVehicle(url string, path string) *HTTPVehicle
  • func (h *HTTPVehicle) Path() string
  • func (h *HTTPVehicle) Read() ([]byte, error)
  • func (h *HTTPVehicle) Type() VehicleType
• type HealthCheck
  • func NewHealthCheck(proxies []C.Proxy, url string, interval uint, lazy bool) *HealthCheck
• type HealthCheckOption
• type Provider
• type ProviderType
  • func (pt ProviderType) String() string
• type ProxyProvider
  • func ParseProxyProvider(name string, mapping map[string]interface{}) (ProxyProvider, error)
• type ProxySchema
• type ProxySetProvider
  • func NewProxySetProvider(name string, interval time.Duration, vehicle Vehicle, hc *HealthCheck) *ProxySetProvider
  • func (pp ProxySetProvider) HealthCheck()
  • func (pp ProxySetProvider) Initial() error
  • func (pp ProxySetProvider) MarshalJSON() ([]byte, error)
  • func (pp ProxySetProvider) Name() string
  • func (pp ProxySetProvider) Proxies() []C.Proxy
  • func (pp ProxySetProvider) ProxiesWithTouch() []C.Proxy
  • func (pp ProxySetProvider) Type() ProviderType
  • func (pp ProxySetProvider) Update() error
• type Vehicle
• type VehicleType
  • func (v VehicleType) String() string

Constants

const (
	ReservedName = "default"
)

Types

type CompatibleProvider

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

for auto gc

func NewCompatibleProvider

func NewCompatibleProvider(name string, proxies []C.Proxy, hc *HealthCheck) (*CompatibleProvider, error)

func (CompatibleProvider) HealthCheck

func (cp CompatibleProvider) HealthCheck()

func (CompatibleProvider) Initial

func (cp CompatibleProvider) Initial() error

func (CompatibleProvider) MarshalJSON

func (cp CompatibleProvider) MarshalJSON() ([]byte, error)

func (CompatibleProvider) Name

func (cp CompatibleProvider) Name() string

func (CompatibleProvider) Proxies

func (cp CompatibleProvider) Proxies() []C.Proxy

func (CompatibleProvider) ProxiesWithTouch

func (cp CompatibleProvider) ProxiesWithTouch() []C.Proxy

func (CompatibleProvider) Type

func (cp CompatibleProvider) Type() ProviderType

func (CompatibleProvider) Update

func (cp CompatibleProvider) Update() error

func (CompatibleProvider) VehicleType

func (cp CompatibleProvider) VehicleType() VehicleType

type FileVehicle

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

func NewFileVehicle

func NewFileVehicle(path string) *FileVehicle

func (*FileVehicle) Path

func (f *FileVehicle) Path() string

func (*FileVehicle) Read

func (f *FileVehicle) Read() ([]byte, error)

func (*FileVehicle) Type

func (f *FileVehicle) Type() VehicleType

type HTTPVehicle

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

func NewHTTPVehicle

func NewHTTPVehicle(url string, path string) *HTTPVehicle

func (*HTTPVehicle) Path

func (h *HTTPVehicle) Path() string

func (*HTTPVehicle) Read

func (h *HTTPVehicle) Read() ([]byte, error)

func (*HTTPVehicle) Type

func (h *HTTPVehicle) Type() VehicleType

type HealthCheck

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

func NewHealthCheck

func NewHealthCheck(proxies []C.Proxy, url string, interval uint, lazy bool) *HealthCheck

type HealthCheckOption

type HealthCheckOption struct {
	URL      string
	Interval uint
}

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() []C.Proxy
	// ProxiesWithTouch is used to inform the provider that the proxy is actually being used while getting the list of proxies.
	// Commonly used in Dial and DialUDP
	ProxiesWithTouch() []C.Proxy
	HealthCheck()
}

ProxyProvider interface

func ParseProxyProvider

func ParseProxyProvider(name string, mapping map[string]interface{}) (ProxyProvider, error)

type ProxySchema

type ProxySchema struct {
	Proxies []map[string]interface{} `yaml:"proxies"`
}

type ProxySetProvider

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

for auto gc

func NewProxySetProvider

func NewProxySetProvider(name string, interval time.Duration, vehicle Vehicle, hc *HealthCheck) *ProxySetProvider

func (ProxySetProvider) HealthCheck

func (pp ProxySetProvider) HealthCheck()

func (ProxySetProvider) Initial

func (pp ProxySetProvider) Initial() error

func (ProxySetProvider) MarshalJSON

func (pp ProxySetProvider) MarshalJSON() ([]byte, error)

func (ProxySetProvider) Name

func (pp ProxySetProvider) Name() string

func (ProxySetProvider) Proxies

func (pp ProxySetProvider) Proxies() []C.Proxy

func (ProxySetProvider) ProxiesWithTouch

func (pp ProxySetProvider) ProxiesWithTouch() []C.Proxy

func (ProxySetProvider) Type

func (pp ProxySetProvider) Type() ProviderType

func (ProxySetProvider) Update

func (pp ProxySetProvider) Update() error

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