clashapi

Documentation

Index

• Variables
• func NewServer(ctx context.Context, router adapter.Router, logFactory log.ObservableFactory, ...) (adapter.ClashServer, error)
• type HTTPError
  • func (e *HTTPError) Error() string
• type Log
• type Memory
• type PatchScriptRequest
• type Rule
• type Server
  • func (s *Server) CacheFile() adapter.ClashCacheFile
  • func (s *Server) Close() error
  • func (s *Server) HistoryStorage() *urltest.HistoryStorage
  • func (s *Server) Mode() string
  • func (s *Server) PreStart() error
  • func (s *Server) RoutedConnection(ctx context.Context, conn net.Conn, metadata adapter.InboundContext, ...) (net.Conn, adapter.Tracker)
  • func (s *Server) RoutedPacketConnection(ctx context.Context, conn N.PacketConn, metadata adapter.InboundContext, ...) (N.PacketConn, adapter.Tracker)
  • func (s *Server) Start() error
  • func (s *Server) StoreFakeIP() bool
  • func (s *Server) StoreSelected() bool
• 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")
	ErrServerError    = newError("Server error")
)

Functions

func NewServer

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

Types

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) CacheFile

func (s *Server) CacheFile() adapter.ClashCacheFile

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) PreStart

func (s *Server) PreStart() error

func (*Server) RoutedConnection

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

func (*Server) RoutedPacketConnection

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

func (*Server) Start

func (s *Server) Start() error

func (*Server) StoreFakeIP

func (s *Server) StoreFakeIP() bool

func (*Server) StoreSelected

func (s *Server) StoreSelected() bool

type Traffic

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

type UpdateProxyRequest

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