api

Documentation

Overview

Package api RESTful API 实现

Index

• type LogBuffer
  • func NewLogBuffer(max int) *LogBuffer
  • func (lb *LogBuffer) Add(entry LogEntry)
  • func (lb *LogBuffer) Recent(n int) []LogEntry
  • func (lb *LogBuffer) Subscribe(id string, bufSize int) (<-chan LogEntry, func())
  • func (lb *LogBuffer) Unsubscribe(id string)
• type LogEntry
• type ReloadFunc
• type RuleProviderManager
• type RuleProviderStats
• type Server
  • func NewServer(addr, secret string) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) SetConfig(cfg *config.Config)
  • func (s *Server) SetConnectionTracker(tracker *stats.ConnectionTracker)
  • func (s *Server) SetDNSResolver(resolver *dns.Resolver)
  • func (s *Server) SetLogBuffer(lb *LogBuffer)
  • func (s *Server) SetManagers(adapterMgr *adapter.Manager, groupMgr *group.Manager, ruleEngine *rules.Engine, ...)
  • func (s *Server) SetProviderManager(mgr RuleProviderManager)
  • func (s *Server) SetReloadFunc(f ReloadFunc)
  • func (s *Server) SetSubscriptionManager(subMgr SubscriptionManager)
  • func (s *Server) Shutdown(ctx context.Context) error
• type SubscriptionManager

Types

type LogBuffer

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

LogBuffer 日志缓冲区，支持 SSE 订阅

func NewLogBuffer

func NewLogBuffer(max int) *LogBuffer

NewLogBuffer 创建日志缓冲区

func (*LogBuffer) Add

func (lb *LogBuffer) Add(entry LogEntry)

Add 添加一条日志

func (*LogBuffer) Recent

func (lb *LogBuffer) Recent(n int) []LogEntry

Recent 获取最近 n 条日志

func (*LogBuffer) Subscribe

func (lb *LogBuffer) Subscribe(id string, bufSize int) (<-chan LogEntry, func())

Subscribe 订阅日志流，返回一个只读通道和取消函数

func (*LogBuffer) Unsubscribe

func (lb *LogBuffer) Unsubscribe(id string)

Unsubscribe 取消订阅

type LogEntry

type LogEntry struct {
	Type    string `json:"type"`
	Payload string `json:"payload"`
	Time    string `json:"time"`
}

LogEntry 日志条目

type ReloadFunc

type ReloadFunc func(configData []byte) error

ReloadFunc 配置重载回调函数类型

type RuleProviderManager

type RuleProviderManager interface {
	Reload(name string) error
	ReloadAll() error
	Stats() map[string]RuleProviderStats
}

RuleProviderManager 规则集提供者管理器接口

type RuleProviderStats

type RuleProviderStats struct {
	Type      string `json:"type"`
	Behavior  string `json:"behavior"`
	Count     int    `json:"count"`
	UpdatedAt string `json:"updatedAt"`
}

RuleProviderStats 提供者统计

type Server

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

Server API 服务器

func NewServer

func NewServer(addr, secret string) *Server

NewServer 创建 API 服务器

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe 启动 API 服务器

func (*Server) SetConfig

func (s *Server) SetConfig(cfg *config.Config)

SetConfig 设置当前配置

func (*Server) SetConnectionTracker

func (s *Server) SetConnectionTracker(tracker *stats.ConnectionTracker)

SetConnectionTracker 设置连接跟踪器

func (*Server) SetDNSResolver

func (s *Server) SetDNSResolver(resolver *dns.Resolver)

SetDNSResolver 设置 DNS 解析器

func (*Server) SetLogBuffer

func (s *Server) SetLogBuffer(lb *LogBuffer)

SetLogBuffer 设置日志缓冲区

func (*Server) SetManagers

func (s *Server) SetManagers(adapterMgr *adapter.Manager, groupMgr *group.Manager, ruleEngine *rules.Engine, statsMgr *stats.Manager)

SetManagers 设置管理器

func (*Server) SetProviderManager

func (s *Server) SetProviderManager(mgr RuleProviderManager)

SetProviderManager 设置规则集提供者管理器

func (*Server) SetReloadFunc

func (s *Server) SetReloadFunc(f ReloadFunc)

SetReloadFunc 设置配置重载回调

func (*Server) SetSubscriptionManager

func (s *Server) SetSubscriptionManager(subMgr SubscriptionManager)

SetSubscriptionManager 设置订阅管理器

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown 关闭服务器

type SubscriptionManager

type SubscriptionManager interface {
	List() []*subscription.Subscription
	GetSubscription(name string) (*subscription.Subscription, bool)
	Update(name string) error
	UpdateAll() error
}

SubscriptionManager 订阅管理器接口