clashapi

Documentation

Index

• Variables
• func NewServer(ctx context.Context, logFactory log.ObservableFactory, ...) (adapter.ClashServer, error)
• type Dir
  • func (d Dir) Open(name string) (http.File, error)
• type HTTPError
  • func (e *HTTPError) Error() string
• type Log
• type Memory
• type PatchScriptRequest
• type Rule
• type Server
  • func (s *Server) Close() error
  • func (s *Server) HistoryStorage() *urltest.HistoryStorage
  • func (s *Server) Mode() string
  • func (s *Server) ModeList() []string
  • func (s *Server) Name() string
  • func (s *Server) RoutedConnection(ctx context.Context, conn net.Conn, metadata adapter.InboundContext, ...) net.Conn
  • func (s *Server) RoutedPacketConnection(ctx context.Context, conn N.PacketConn, metadata adapter.InboundContext, ...) N.PacketConn
  • func (s *Server) SetMode(newMode string)
  • func (s *Server) SetModeUpdateHook(hook chan<- struct{})
  • func (s *Server) Start(stage adapter.StartStage) error
  • func (s *Server) TrafficManager() *trafficontrol.Manager
• type Traffic
• type UpdateProxyRequest

Variables

var (
	CtxKeyProxyName    = contextKey("proxy name")
	CtxKeyProviderName = contextKey("provider name")
	CtxKeyProxy        = contextKey("proxy")
	CtxKeyProvider     = contextKey("provider")
)

var (
	ErrUnauthorized   = newError("Unauthorized")
	ErrBadRequest     = newError("Body invalid")
	ErrForbidden      = newError("Forbidden")
	ErrNotFound       = newError("Resource not found")
	ErrRequestTimeout = newError("Timeout")
)

Functions

func NewServer

func NewServer(ctx context.Context, logFactory log.ObservableFactory, options option.ClashAPIOptions) (adapter.ClashServer, error)

Types

type Dir

type Dir http.Dir

func (Dir) Open

func (d Dir) Open(name string) (http.File, error)

type HTTPError

type HTTPError struct {
	Message string `json:"message"`
}

HTTPError is custom HTTP error for API

func (*HTTPError) Error

func (e *HTTPError) Error() string

type Log

type Log struct {
	Type    string `json:"type"`
	Payload string `json:"payload"`
}

type Memory

type Memory struct {
	Inuse   uint64 `json:"inuse"`
	OSLimit uint64 `json:"oslimit"` // maybe we need it in the future
}

type PatchScriptRequest

type PatchScriptRequest struct {
	Script string `json:"script"`
}

type Rule

type Rule struct {
	Type    string `json:"type"`
	Payload string `json:"payload"`
	Proxy   string `json:"proxy"`
}

type Server

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

func (*Server) Close

func (s *Server) Close() error

func (*Server) HistoryStorage

func (s *Server) HistoryStorage() *urltest.HistoryStorage

func (*Server) Mode

func (s *Server) Mode() string

func (*Server) ModeList

func (s *Server) ModeList() []string

func (*Server) Name

func (s *Server) Name() string

func (*Server) RoutedConnection

func (s *Server) RoutedConnection(ctx context.Context, conn net.Conn, metadata adapter.InboundContext, matchedRule adapter.Rule, matchOutbound adapter.Outbound) net.Conn

func (*Server) RoutedPacketConnection

func (s *Server) RoutedPacketConnection(ctx context.Context, conn N.PacketConn, metadata adapter.InboundContext, matchedRule adapter.Rule, matchOutbound adapter.Outbound) N.PacketConn

func (*Server) SetMode

func (s *Server) SetMode(newMode string)

func (*Server) SetModeUpdateHook

func (s *Server) SetModeUpdateHook(hook chan<- struct{})

func (*Server) Start

func (s *Server) Start(stage adapter.StartStage) error

func (*Server) TrafficManager

func (s *Server) TrafficManager() *trafficontrol.Manager

type Traffic

type Traffic struct {
	Up   int64 `json:"up"`
	Down int64 `json:"down"`
}

type UpdateProxyRequest

type UpdateProxyRequest struct {
	Name string `json:"name"`
}