pkg

Jan 8, 2026

Changes in this version

type APIError

+ func (e *APIError) IsClientError() bool

type Client

+ func (c *Client) RawUsersByNodeId(nodeId NodeId, nodeType NodeType) (rawData []byte, err error)

+ func (c *Client) UsersByNodeId(nodeId NodeId, nodeType NodeType) (UserList *[]User, err error)

type ErrorType

+ const ErrorTypeClientError

Dec 11, 2025

Changes in this version

type TuicConfig

+ ZeroRttHandshake bool

Dec 2, 2025

Changes in this version

type NodeType

+ const Tuic

+ type TuicConfig struct

+ AllowInsecure int

+ ID int

+ ServerName string

+ ServerPort int

+ func AsTuicConfig(nc NodeConfig) (*TuicConfig, error)

+ func UnmarshalTuicConfig(data []byte) (*TuicConfig, error)

+ func (n *TuicConfig) String() string

+ func (n *TuicConfig) TypeName() string

Oct 29, 2025

Changes in this version

type Client

+ func (c *Client) Verify(registerId string, nodeType NodeType) (bool, error)

+ type RespVerify RespSubmit

Oct 16, 2025

Changes in this version

+ type APIError struct

+ Err error

+ Message string

+ StatusCode int

+ Type ErrorType

+ URL string

+ func NewAPIError(statusCode int, errorType ErrorType, message string, url string, err error) *APIError

+ func NewAPIErrorFromStatusCode(statusCode int, message string, url string, err error) *APIError

+ func NewBusinessLogicError(message string, url string) *APIError

+ func NewNetworkError(message string, url string, err error) *APIError

+ func NewNotModifiedError() *APIError

+ func NewParseError(message string, err error) *APIError

+ func (e *APIError) Error() string

+ func (e *APIError) IsNetworkError() bool

+ func (e *APIError) IsNotModified() bool

+ func (e *APIError) IsParseError() bool

+ func (e *APIError) IsServerError() bool

+ func (e *APIError) Unwrap() error

type Client

+ func (c *Client) Register(nodeId NodeId, nodeType NodeType, hostname string, port int, nodeIp string) (registerId int, err error)

+ func (c *Client) Unregister(nodeType NodeType, registerId int) error

+ type ErrorType string

+ const ErrorTypeNetworkError

+ const ErrorTypeNotModified

+ const ErrorTypeParseError

+ const ErrorTypeServerError

+ const ErrorTypeUnknown

+ type RespRegister struct

+ Data struct{ ... }

+ Message string

+ type RespUnregister RespSubmit

Apr 14, 2025

Changes in this version

+ func UnmarshalConfig[T any](data []byte) (*T, error)

+ type AnyTLSConfig struct

+ AllowInsecure int

+ ID int

+ PaddingRules string

+ ServerName string

+ ServerPort int

+ func AsAnyTLSConfig(nc NodeConfig) (*AnyTLSConfig, error)

+ func UnmarshalAnyTLSConfig(data []byte) (*AnyTLSConfig, error)

+ func (n *AnyTLSConfig) String() string

+ func (n *AnyTLSConfig) TypeName() string

type NodeType

+ const AnyTLS

Mar 13, 2024

Changes in this version

+ var ErrorUserNotModified = errors.New("users not modified")

Nov 30, 2023

Changes in this version

+ func MarshalTrafficStats(stats TrafficStats) ([]byte, error)

+ func MarshalTraffics(traffics []*UserTraffic) ([]byte, error)

Nov 27, 2023

Changes in this version

+ func AsConfig[T NodeConfig](nc NodeConfig) (T, error)

+ func UnmarshalUsers(data []byte) (*[]User, error)

+ type Client struct

+ func New(apiConfig *Config) *Client

+ func (c *Client) Config(nodeId NodeId, nodeType NodeType) (config NodeConfig, err error)

+ func (c *Client) Debug(enable bool)

+ func (c *Client) Heartbeat(nodeId NodeId, nodeType NodeType, nodeIp string) error

+ func (c *Client) RawConfig(nodeId NodeId, nodeType NodeType) (rawData []byte, err error)

+ func (c *Client) RawUsers(nodeId NodeId, nodeType NodeType) (rawData []byte, err error)

+ func (c *Client) Submit(nodeId NodeId, nodeType NodeType, userTraffic []*UserTraffic) error

+ func (c *Client) SubmitStatsWithAgent(nodeId NodeId, nodeType NodeType, nodeIp string, stats *TrafficStats) error

+ func (c *Client) SubmitWithAgent(nodeId NodeId, nodeType NodeType, userTraffic []*UserTraffic) error

+ func (c *Client) Users(nodeId NodeId, nodeType NodeType) (UserList *[]User, err error)

+ type Config struct

+ APIHost string

+ Debug bool

+ Timeout time.Duration

+ Token string

+ type Hysteria2Config struct

+ DisableUDP bool

+ DownMbps int

+ ID int

+ IgnoreCliBandWidth bool

+ Obfs string

+ ServerPort int

+ UpMbps int

+ func AsHysteria2Config(nc NodeConfig) (*Hysteria2Config, error)

+ func UnmarshalHysteria2Config(data []byte) (*Hysteria2Config, error)

+ func (n *Hysteria2Config) String() string

+ func (n *Hysteria2Config) TypeName() string

+ type HysteriaConfig struct

+ DisableMTUDiscovery bool

+ DisableUdp bool

+ DownMbps int

+ ID int

+ Obfs string

+ Protocol string

+ ServerPort int

+ UpMbps int

+ func AsHysteriaConfig(nc NodeConfig) (*HysteriaConfig, error)

+ func UnmarshalHysteriaConfig(data []byte) (*HysteriaConfig, error)

+ func (n *HysteriaConfig) String() string

+ func (n *HysteriaConfig) TypeName() string

+ type NodeConfig interface

+ String func() string

+ TypeName func() string

+ type NodeId int

+ type NodeType string

+ const Hysteria

+ const Hysteria2

+ const ShadowSocks

+ const Trojan

+ const VMess

+ func (n NodeType) String() string

+ type RespConfig struct

+ Data NodeConfig

+ Message string

+ type RespHeartBeat RespSubmit

+ type RespSubmit struct

+ Data bool

+ Message string

+ type RespSubmitStatsWithAgent RespSubmit

+ type RespSubmitWithAgent RespSubmit

+ type RespUsers struct

+ Data *[]User

+ Message string

+ type ShadowsocksConfig struct

+ ID int

+ Method string

+ Network string

+ ServerPort int

+ func AsShadowsocksConfig(nc NodeConfig) (*ShadowsocksConfig, error)

+ func UnmarshalShadowsocksConfig(data []byte) (*ShadowsocksConfig, error)

+ func (n *ShadowsocksConfig) String() string

+ func (n *ShadowsocksConfig) TypeName() string

+ type TrafficStats struct

+ Count int

+ Requests int

+ UserIds []int

+ UserRequests map[int]int

+ type TrojanConfig struct

+ AllowInsecure int

+ GrpcConfig *conf.GRPCConfig

+ ID int

+ Network string

+ ServerName string

+ ServerPort int

+ WebSocketConfig *conf.WebSocketConfig

+ func AsTrojanConfig(nc NodeConfig) (*TrojanConfig, error)

+ func UnmarshalTrojanConfig(data []byte) (*TrojanConfig, error)

+ func (n *TrojanConfig) String() string

+ func (n *TrojanConfig) TypeName() string

+ type User struct

+ ID int

+ UUID string

+ type UserTraffic struct

+ Count uint64

+ Download uint64

+ UID int

+ Upload uint64

+ type VMessConfig struct

+ DnsSettings *conf.DNSConfig

+ GrpcConfig *conf.GRPCConfig

+ H2Config *conf.HTTPConfig

+ ID int

+ Network string

+ RouterSettings *conf.RouterConfig

+ ServerPort int

+ TLS int

+ TcpConfig *conf.TCPConfig

+ TlsConfig *conf.TLSConfig

+ WebSocketConfig *conf.WebSocketConfig

+ func AsVMessConfig(nc NodeConfig) (*VMessConfig, error)

+ func UnmarshalVMessConfig(data []byte) (*VMessConfig, error)

+ func (n *VMessConfig) String() string

+ func (n *VMessConfig) TypeName() string