constant

Documentation

Index

• Constants
• Variables
• func SetHomeDir(root string)
• type AdapterType
  • func (at AdapterType) String() string
• type General
• type LogLevel
  • func (l LogLevel) String() string
• type Metadata
  • func (addr *Metadata) String() string
• type NetWork
  • func (n *NetWork) String() string
• type Proxy
• type ProxyAdapter
• type ProxySignal
• type Rule
• type RuleType
  • func (rt RuleType) String() string
• type ServerAdapter
• type SourceType
• type Traffic
  • func NewTraffic(interval time.Duration) *Traffic
  • func (t *Traffic) Down() chan<- int64
  • func (t *Traffic) Now() (up int64, down int64)
  • func (t *Traffic) Up() chan<- int64

Constants

const (
	AtypIPv4       = 1
	AtypDomainName = 3
	AtypIPv6       = 4

	TCP NetWork = iota
	UDP

	HTTP SourceType = iota
	SOCKS
)

Socks addr type

const Name = "clash"

Variables

var (
	// LogLevelMapping is a mapping for LogLevel enum
	LogLevelMapping = map[string]LogLevel{
		"error":   ERROR,
		"warning": WARNING,
		"info":    INFO,
		"debug":   DEBUG,
	}
)

var Path *path

Path is used to get the configuration path

Functions

func SetHomeDir

func SetHomeDir(root string)

SetHomeDir is used to set the configuration path

Types

type AdapterType

type AdapterType int

AdapterType is enum of adapter type

const (
	Direct AdapterType = iota
	Fallback
	Reject
	Selector
	Shadowsocks
	Socks5
	URLTest
	Vmess
)

Adapter Type

func (AdapterType) String

func (at AdapterType) String() string

type General

type General struct {
	Mode      *string `json:"mode,omitempty"`
	AllowLan  *bool   `json:"allow-lan,omitempty"`
	Port      *int    `json:"port,omitempty"`
	SocksPort *int    `json:"socks-port,omitempty"`
	RedirPort *int    `json:"redir-port,omitempty"`
	LogLevel  *string `json:"log-level,omitempty"`
}

type LogLevel

type LogLevel int

const (
	ERROR LogLevel = iota
	WARNING
	INFO
	DEBUG
)

func (LogLevel) String

func (l LogLevel) String() string

type Metadata

type Metadata struct {
	NetWork  NetWork
	Source   SourceType
	AddrType int
	Host     string
	IP       *net.IP
	Port     string
}

Metadata is used to store connection address

func (*Metadata) String

func (addr *Metadata) String() string

type NetWork

type NetWork int

func (*NetWork) String

func (n *NetWork) String() string

type Proxy

type Proxy interface {
	Name() string
	Type() AdapterType
	Generator(metadata *Metadata) (ProxyAdapter, error)
}

type ProxyAdapter

type ProxyAdapter interface {
	Conn() net.Conn
	Close()
}

type ProxySignal

type ProxySignal struct {
	Done   chan<- struct{}
	Closed <-chan struct{}
}

ProxySignal is used to handle graceful shutdown of proxy

type Rule

type Rule interface {
	RuleType() RuleType
	IsMatch(metadata *Metadata) bool
	Adapter() string
	Payload() string
}

type RuleType

type RuleType int

const (
	Domain RuleType = iota
	DomainSuffix
	DomainKeyword
	GEOIP
	IPCIDR
	FINAL
)

Rule Type

func (RuleType) String

func (rt RuleType) String() string

type ServerAdapter

type ServerAdapter interface {
	Metadata() *Metadata
	Close()
}

type SourceType

type SourceType int

type Traffic

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

func NewTraffic

func NewTraffic(interval time.Duration) *Traffic

func (*Traffic) Down

func (t *Traffic) Down() chan<- int64

func (*Traffic) Now

func (t *Traffic) Now() (up int64, down int64)

func (*Traffic) Up

func (t *Traffic) Up() chan<- int64