Documentation
¶
Index ¶
- Constants
- Variables
- func SetConfig(file string)
- func SetHomeDir(root string)
- type AdapterType
- type Chain
- type Conn
- type Connection
- type DelayHistory
- type Metadata
- type NetWork
- type PacketConn
- type Proxy
- type ProxyAdapter
- type Rule
- type RuleType
- type ServerAdapter
- type Traffic
- type Type
- type UDPPacket
Constants ¶
View Source
const ( AtypIPv4 = 1 AtypDomainName = 3 AtypIPv6 = 4 TCP NetWork = iota UDP HTTP Type = iota HTTPCONNECT SOCKS REDIR )
Socks addr type
View Source
const Name = "clash"
Variables ¶
View Source
var ( Version = "unknown version" BuildTime = "unknown time" )
View Source
var Path *path
Path is used to get the configuration path
Functions ¶
Types ¶
type AdapterType ¶ added in v0.5.0
type AdapterType int
AdapterType is enum of adapter type
const ( Direct AdapterType = iota Reject Shadowsocks ShadowsocksR Snell Socks5 Http Vmess Trojan Relay Selector Fallback URLTest LoadBalance )
Adapter Type
func (AdapterType) String ¶ added in v0.5.0
func (at AdapterType) String() string
type Conn ¶
type Conn interface {
net.Conn
Connection
}
type Connection ¶
type Connection interface {
Chains() Chain
AppendToChains(adapter ProxyAdapter)
}
type DelayHistory ¶
type Metadata ¶
type Metadata struct {
NetWork NetWork `json:"network"`
Type Type `json:"type"`
SrcIP net.IP `json:"sourceIP"`
DstIP net.IP `json:"destinationIP"`
SrcPort string `json:"sourcePort"`
DstPort string `json:"destinationPort"`
AddrType int `json:"-"`
Host string `json:"host"`
}
Metadata is used to store connection address
func (*Metadata) RemoteAddress ¶
func (*Metadata) SourceAddress ¶
type PacketConn ¶
type PacketConn interface {
net.PacketConn
Connection
}
type ProxyAdapter ¶
type ProxyAdapter interface {
Name() string
Type() AdapterType
StreamConn(c net.Conn, metadata *Metadata) (net.Conn, error)
DialContext(ctx context.Context, metadata *Metadata) (Conn, error)
DialUDP(metadata *Metadata) (PacketConn, error)
SupportUDP() bool
MarshalJSON() ([]byte, error)
Addr() string
// Unwrap extracts the proxy from a proxy-group. It returns nil when nothing to extract.
Unwrap(metadata *Metadata) Proxy
}
type RuleType ¶
type RuleType int
type ServerAdapter ¶
type Traffic ¶ added in v0.4.0
type Traffic struct {
// contains filtered or unexported fields
}
func NewTraffic ¶ added in v0.4.0
type UDPPacket ¶
type UDPPacket interface {
// Data get the payload of UDP Packet
Data() []byte
// WriteBack writes the payload with source IP/Port equals addr
// - variable source IP/Port is important to STUN
// - if addr is not provided, WriteBack will wirte out UDP packet with SourceIP/Prot equals to origional Target,
// this is important when using Fake-IP.
WriteBack(b []byte, addr net.Addr) (n int, err error)
// Drop call after packet is used, could recycle buffer in this function.
Drop()
// LocalAddr returns the source IP/Port of packet
LocalAddr() net.Addr
}
UDPPacket contains the data of UDP packet, and offers control/info of UDP packet's source
Click to show internal directories.
Click to hide internal directories.