router

Documentation

Index

• type Action
• type Mode
• type Router
  • func NewRouter(path string) (*Router, error)
  • func (r *Router) Match(host string) Action
• type Rule
• type RuleType

Types

type Action

type Action string

Action定义流量走向

const (
	ActionProxy  Action = "PROXY"  // 走代理
	ActionDirect Action = "DIRECT" // 直连
	ActionReject Action = "REJECT" // 拒绝
)

type Mode

type Mode string

Mode定义全局路由的模式

const (
	ModeRule   Mode = "rule"   // 规则模式
	ModeDirect Mode = "direct" // 全局直连
	ModeGlobal Mode = "global" // 全局代理
)

type Router

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

Router 路由的核心结构体

func NewRouter

func NewRouter(path string) (*Router, error)

从指定YAML文件路径中创建并初始化一个新的Router

func (*Router) Match

func (r *Router) Match(host string) Action

根据主机名决定流量的走向

type Rule

type Rule struct {
	Type    RuleType
	Payload string // ip或者域名（具体的待匹配值）
	Target  Action // 动作
}

Rule 代表一条路由规则

type RuleType

type RuleType string

定义规则类型

const (
	DomainSuffix  RuleType = "DOMAIN-SUFFIX"  // 域名后缀匹配
	DomainKeyword RuleType = "DOMAIN-KEYWORD" // 域名关键字匹配
	Domain        RuleType = "DOMAIN"         // 完整域名匹配
	IPCIDR        RuleType = "IP-CIDR"        // IP段匹配
	IPCIDR6       RuleType = "IP-CIDR6"       // IPv6
	Match         RuleType = "MATCH"          // 所有规则都没命中时的匹配
)