Documentation
¶
Index ¶
- Constants
- func CheckConfig(configContent string) error
- func ClearServiceError()
- func DecodeLengthChunk(data []byte) int32
- func EncodeChunkedMessage(data []byte) []byte
- func FormatBytes(length int64) string
- func FormatConfig(configContent string) (string, error)
- func FormatMemoryBytes(length int64) string
- func GenerateRemoteProfileImportLink(name string, remoteURL string) string
- func ProxyDisplayType(proxyType string) string
- func ReadServiceError() (string, error)
- func RedirectStderr(path string) error
- func RegisterLocalDNSTransport(transport LocalDNSTransport)
- func SetMemoryLimit(enabled bool)
- func Setup(basePath string, workingPath string, tempPath string, isTVOS bool)
- func SetupWithUsername(basePath string, workingPath string, tempPath string, username string) error
- func Version() string
- func WriteServiceError(message string) error
- type BoxService
- type CommandClient
- func (c *CommandClient) CloseConnections() error
- func (c *CommandClient) Connect() error
- func (c *CommandClient) Disconnect() error
- func (c *CommandClient) GetSystemProxyStatus() (*SystemProxyStatus, error)
- func (c *CommandClient) SelectOutbound(groupTag string, outboundTag string) error
- func (c *CommandClient) ServiceReload() error
- func (c *CommandClient) SetClashMode(newMode string) error
- func (c *CommandClient) SetGroupExpand(groupTag string, isExpand bool) error
- func (c *CommandClient) SetSystemProxyEnabled(isEnabled bool) error
- func (c *CommandClient) URLTest(groupTag string) error
- type CommandClientHandler
- type CommandClientOptions
- type CommandServer
- type CommandServerHandler
- type ErrorMessage
- type ExchangeContext
- type Func
- type HTTPClient
- type HTTPRequest
- type HTTPResponse
- type ImportRemoteProfile
- type InterfaceUpdateListener
- type LocalDNSTransport
- type NetworkInterface
- type NetworkInterfaceIterator
- type OnDemandRule
- type OnDemandRuleIterator
- type OutboundGroup
- type OutboundGroupItem
- type OutboundGroupItemIterator
- type OutboundGroupIterator
- type PProfServer
- type PlatformInterface
- type ProfileContent
- type ProfileContentRequest
- type ProfileDecoder
- type ProfileEncoder
- type ProfilePreview
- type ProfilePreviewIterator
- type RoutePrefix
- type RoutePrefixIterator
- type StatusMessage
- type StringIterator
- type SystemProxyStatus
- type TunInterface
- type TunOptions
- type WIFIState
Constants ¶
View Source
const ( CommandLog int32 = iota CommandStatus CommandServiceReload CommandCloseConnections CommandGroup CommandSelectOutbound CommandURLTest CommandGroupExpand CommandClashMode CommandSetClashMode CommandGetSystemProxyStatus CommandSetSystemProxyEnabled )
View Source
const ( MessageTypeError = iota MessageTypeProfileList MessageTypeProfileContentRequest MessageTypeProfileContent )
View Source
const ( ProfileTypeLocal int32 = iota ProfileTypeiCloud ProfileTypeRemote )
Variables ¶
This section is empty.
Functions ¶
func CheckConfig ¶ added in v1.2.3
func ClearServiceError ¶ added in v1.8.4
func ClearServiceError()
func DecodeLengthChunk ¶ added in v1.3.5
func EncodeChunkedMessage ¶ added in v1.3.5
func FormatBytes ¶
func FormatConfig ¶ added in v1.2.3
func FormatMemoryBytes ¶ added in v1.4.4
func GenerateRemoteProfileImportLink ¶ added in v1.3.5
func ProxyDisplayType ¶ added in v1.3.6
func ReadServiceError ¶ added in v1.8.4
func RedirectStderr ¶ added in v1.2.4
func RegisterLocalDNSTransport ¶ added in v1.3.0
func RegisterLocalDNSTransport(transport LocalDNSTransport)
func SetMemoryLimit ¶ added in v1.3.3
func SetMemoryLimit(enabled bool)
func SetupWithUsername ¶ added in v1.3.3
func WriteServiceError ¶ added in v1.8.4
Types ¶
type BoxService ¶
type BoxService struct {
// contains filtered or unexported fields
}
func NewService ¶
func NewService(configContent string, platformInterface PlatformInterface) (*BoxService, error)
func (*BoxService) Close ¶
func (s *BoxService) Close() error
func (*BoxService) Sleep ¶ added in v1.3.6
func (s *BoxService) Sleep()
func (*BoxService) Start ¶
func (s *BoxService) Start() error
func (*BoxService) Wake ¶ added in v1.3.6
func (s *BoxService) Wake()
type CommandClient ¶ added in v1.2.3
type CommandClient struct {
// contains filtered or unexported fields
}
func NewCommandClient ¶ added in v1.2.3
func NewCommandClient(handler CommandClientHandler, options *CommandClientOptions) *CommandClient
func NewStandaloneCommandClient ¶ added in v1.3.3
func NewStandaloneCommandClient() *CommandClient
func (*CommandClient) CloseConnections ¶ added in v1.3.3
func (c *CommandClient) CloseConnections() error
func (*CommandClient) Connect ¶ added in v1.2.3
func (c *CommandClient) Connect() error
func (*CommandClient) Disconnect ¶ added in v1.2.3
func (c *CommandClient) Disconnect() error
func (*CommandClient) GetSystemProxyStatus ¶ added in v1.4.2
func (c *CommandClient) GetSystemProxyStatus() (*SystemProxyStatus, error)
func (*CommandClient) SelectOutbound ¶ added in v1.3.3
func (c *CommandClient) SelectOutbound(groupTag string, outboundTag string) error
func (*CommandClient) ServiceReload ¶ added in v1.3.3
func (c *CommandClient) ServiceReload() error
func (*CommandClient) SetClashMode ¶ added in v1.4.0
func (c *CommandClient) SetClashMode(newMode string) error
func (*CommandClient) SetGroupExpand ¶ added in v1.4.0
func (c *CommandClient) SetGroupExpand(groupTag string, isExpand bool) error
func (*CommandClient) SetSystemProxyEnabled ¶ added in v1.4.2
func (c *CommandClient) SetSystemProxyEnabled(isEnabled bool) error
func (*CommandClient) URLTest ¶ added in v1.3.3
func (c *CommandClient) URLTest(groupTag string) error
type CommandClientHandler ¶ added in v1.2.3
type CommandClientHandler interface {
Connected()
Disconnected(message string)
ClearLog()
WriteLog(message string)
WriteStatus(message *StatusMessage)
WriteGroups(message OutboundGroupIterator)
InitializeClashMode(modeList StringIterator, currentMode string)
UpdateClashMode(newMode string)
}
type CommandClientOptions ¶ added in v1.2.3
type CommandServer ¶ added in v1.2.3
type CommandServer struct {
// contains filtered or unexported fields
}
func NewCommandServer ¶ added in v1.2.3
func NewCommandServer(handler CommandServerHandler, maxLines int32) *CommandServer
func (*CommandServer) Close ¶ added in v1.2.3
func (s *CommandServer) Close() error
func (*CommandServer) SetService ¶ added in v1.3.3
func (s *CommandServer) SetService(newService *BoxService)
func (*CommandServer) Start ¶ added in v1.2.3
func (s *CommandServer) Start() error
func (*CommandServer) WriteMessage ¶ added in v1.2.3
func (s *CommandServer) WriteMessage(message string)
type CommandServerHandler ¶ added in v1.2.3
type CommandServerHandler interface {
ServiceReload() error
GetSystemProxyStatus() *SystemProxyStatus
SetSystemProxyEnabled(isEnabled bool) error
}
type ErrorMessage ¶ added in v1.3.5
type ErrorMessage struct {
Message string
}
func DecodeErrorMessage ¶ added in v1.3.5
func DecodeErrorMessage(data []byte) (*ErrorMessage, error)
func (*ErrorMessage) Encode ¶ added in v1.3.5
func (e *ErrorMessage) Encode() []byte
type ExchangeContext ¶ added in v1.3.0
type ExchangeContext struct {
// contains filtered or unexported fields
}
func (*ExchangeContext) ErrnoCode ¶ added in v1.3.0
func (c *ExchangeContext) ErrnoCode(code int32)
func (*ExchangeContext) ErrorCode ¶ added in v1.3.0
func (c *ExchangeContext) ErrorCode(code int32)
func (*ExchangeContext) OnCancel ¶ added in v1.3.0
func (c *ExchangeContext) OnCancel(callback Func)
func (*ExchangeContext) RawSuccess ¶ added in v1.3.0
func (c *ExchangeContext) RawSuccess(result []byte)
func (*ExchangeContext) Success ¶ added in v1.3.0
func (c *ExchangeContext) Success(result string)
type HTTPClient ¶ added in v1.2.3
type HTTPClient interface {
RestrictedTLS()
ModernTLS()
PinnedTLS12()
PinnedSHA256(sumHex string)
TrySocks5(port int32)
KeepAlive()
NewRequest() HTTPRequest
Close()
}
func NewHTTPClient ¶ added in v1.2.3
func NewHTTPClient() HTTPClient
type HTTPRequest ¶ added in v1.2.3
type HTTPResponse ¶ added in v1.2.3
type ImportRemoteProfile ¶ added in v1.3.5
func ParseRemoteProfileImportLink ¶ added in v1.3.5
func ParseRemoteProfileImportLink(importLink string) (*ImportRemoteProfile, error)
type InterfaceUpdateListener ¶ added in v1.2.5
type LocalDNSTransport ¶ added in v1.3.0
type LocalDNSTransport interface {
Raw() bool
Lookup(ctx *ExchangeContext, network string, domain string) error
Exchange(ctx *ExchangeContext, message []byte) error
}
type NetworkInterface ¶ added in v1.2.5
type NetworkInterface struct {
Index int32
MTU int32
Name string
Addresses StringIterator
}
type NetworkInterfaceIterator ¶ added in v1.2.5
type NetworkInterfaceIterator interface {
Next() *NetworkInterface
HasNext() bool
}
type OnDemandRule ¶
type OnDemandRule interface {
Target() int32
DNSSearchDomainMatch() StringIterator
DNSServerAddressMatch() StringIterator
InterfaceTypeMatch() int32
SSIDMatch() StringIterator
ProbeURL() string
}
type OnDemandRuleIterator ¶
type OnDemandRuleIterator interface {
Next() OnDemandRule
HasNext() bool
}
type OutboundGroup ¶ added in v1.3.3
type OutboundGroup struct {
Tag string
Type string
Selectable bool
Selected string
IsExpand bool
// contains filtered or unexported fields
}
func (*OutboundGroup) GetItems ¶ added in v1.3.3
func (g *OutboundGroup) GetItems() OutboundGroupItemIterator
type OutboundGroupItem ¶ added in v1.3.3
type OutboundGroupItemIterator ¶ added in v1.3.3
type OutboundGroupItemIterator interface {
Next() *OutboundGroupItem
HasNext() bool
}
type OutboundGroupIterator ¶ added in v1.3.3
type OutboundGroupIterator interface {
Next() *OutboundGroup
HasNext() bool
}
type PProfServer ¶
type PProfServer struct {
// contains filtered or unexported fields
}
func NewPProfServer ¶
func NewPProfServer(port int) *PProfServer
func (*PProfServer) Close ¶
func (s *PProfServer) Close() error
func (*PProfServer) Start ¶
func (s *PProfServer) Start() error
type PlatformInterface ¶
type PlatformInterface interface {
UsePlatformAutoDetectInterfaceControl() bool
AutoDetectInterfaceControl(fd int32) error
OpenTun(options TunOptions) (int32, error)
WriteLog(message string)
UseProcFS() bool
FindConnectionOwner(ipProtocol int32, sourceAddress string, sourcePort int32, destinationAddress string, destinationPort int32) (int32, error)
PackageNameByUid(uid int32) (string, error)
UIDByPackageName(packageName string) (int32, error)
UsePlatformDefaultInterfaceMonitor() bool
StartDefaultInterfaceMonitor(listener InterfaceUpdateListener) error
CloseDefaultInterfaceMonitor(listener InterfaceUpdateListener) error
UsePlatformInterfaceGetter() bool
GetInterfaces() (NetworkInterfaceIterator, error)
UnderNetworkExtension() bool
ReadWIFIState() *WIFIState
ClearDNSCache()
}
type ProfileContent ¶ added in v1.3.5
type ProfileContent struct {
Name string
Type int32
Config string
RemotePath string
AutoUpdate bool
AutoUpdateInterval int32
LastUpdated int64
}
func DecodeProfileContent ¶ added in v1.3.5
func DecodeProfileContent(data []byte) (*ProfileContent, error)
func (*ProfileContent) Encode ¶ added in v1.3.5
func (c *ProfileContent) Encode() []byte
type ProfileContentRequest ¶ added in v1.3.5
type ProfileContentRequest struct {
ProfileID int64
}
func DecodeProfileContentRequest ¶ added in v1.3.5
func DecodeProfileContentRequest(data []byte) (*ProfileContentRequest, error)
func (*ProfileContentRequest) Encode ¶ added in v1.3.5
func (r *ProfileContentRequest) Encode() []byte
type ProfileDecoder ¶ added in v1.3.5
type ProfileDecoder struct {
// contains filtered or unexported fields
}
func (*ProfileDecoder) Decode ¶ added in v1.3.5
func (d *ProfileDecoder) Decode(data []byte) error
func (*ProfileDecoder) Iterator ¶ added in v1.3.5
func (d *ProfileDecoder) Iterator() ProfilePreviewIterator
type ProfileEncoder ¶ added in v1.3.5
type ProfileEncoder struct {
// contains filtered or unexported fields
}
func (*ProfileEncoder) Append ¶ added in v1.3.5
func (e *ProfileEncoder) Append(profile *ProfilePreview)
func (*ProfileEncoder) Encode ¶ added in v1.3.5
func (e *ProfileEncoder) Encode() []byte
type ProfilePreview ¶ added in v1.3.5
type ProfilePreviewIterator ¶ added in v1.3.5
type ProfilePreviewIterator interface {
Next() *ProfilePreview
HasNext() bool
}
type RoutePrefix ¶
type RoutePrefix struct {
// contains filtered or unexported fields
}
func (*RoutePrefix) Address ¶
func (p *RoutePrefix) Address() string
func (*RoutePrefix) Mask ¶
func (p *RoutePrefix) Mask() string
func (*RoutePrefix) Prefix ¶
func (p *RoutePrefix) Prefix() int32
func (*RoutePrefix) String ¶ added in v1.7.5
func (p *RoutePrefix) String() string
type RoutePrefixIterator ¶
type RoutePrefixIterator interface {
Next() *RoutePrefix
HasNext() bool
}
type StatusMessage ¶ added in v1.2.3
type StringIterator ¶
type SystemProxyStatus ¶ added in v1.4.2
type TunInterface ¶
type TunOptions ¶
type TunOptions interface {
GetInet4Address() RoutePrefixIterator
GetInet6Address() RoutePrefixIterator
GetDNSServerAddress() (string, error)
GetMTU() int32
GetAutoRoute() bool
GetStrictRoute() bool
GetInet4RouteAddress() RoutePrefixIterator
GetInet6RouteAddress() RoutePrefixIterator
GetInet4RouteExcludeAddress() RoutePrefixIterator
GetInet6RouteExcludeAddress() RoutePrefixIterator
GetInet4RouteRange() RoutePrefixIterator
GetInet6RouteRange() RoutePrefixIterator
GetIncludePackage() StringIterator
GetExcludePackage() StringIterator
IsHTTPProxyEnabled() bool
GetHTTPProxyServer() string
GetHTTPProxyServerPort() int32
}
Source Files
¶
- command.go
- command_clash_mode.go
- command_client.go
- command_conntrack.go
- command_group.go
- command_log.go
- command_reload.go
- command_select.go
- command_server.go
- command_shared.go
- command_status.go
- command_system_proxy.go
- command_urltest.go
- config.go
- dns.go
- http.go
- iterator.go
- log.go
- memory.go
- monitor.go
- platform.go
- pprof.go
- profile_import.go
- remote_profile.go
- service.go
- service_error.go
- service_other.go
- setup.go
- tun.go
- tun_name_linux.go
Click to show internal directories.
Click to hide internal directories.