mirror of
https://github.com/Control-D-Inc/ctrld.git
synced 2026-02-03 22:18:39 +00:00
4792183c0d
This commit extends the documentation effort by adding detailed explanatory comments to key CLI components and core functionality throughout the cmd/ directory. The changes focus on explaining WHY certain logic is needed, not just WHAT the code does, improving code maintainability and helping developers understand complex business decisions. Key improvements: - Main entry points: Document CLI initialization, logging setup, and cache configuration with reasoning for design decisions - DNS proxy core: Explain DNS proxy constants, data structures, and core processing pipeline for handling DNS queries - Service management: Document service command structure, configuration patterns, and platform-specific service handling - Logging infrastructure: Explain log buffer management, level encoders, and log formatting decisions for different use cases - Metrics and monitoring: Document Prometheus metrics structure, HTTP endpoints, and conditional metric collection for performance - Network handling: Explain Linux-specific network interface filtering, virtual interface detection, and DNS configuration management - Hostname validation: Document RFC1123 compliance and DNS naming standards for system compatibility - Mobile integration: Explain HTTP retry logic, fallback mechanisms, and mobile platform integration patterns - Connection management: Document connection wrapper design to prevent log pollution during process lifecycle Technical details: - Added explanatory comments to 11 additional files in cmd/cli/ - Maintained consistent documentation style and format - Preserved all existing functionality while improving code clarity - Enhanced understanding of complex business logic and platform-specific behavior These comments help future developers understand the reasoning behind complex decisions, making the codebase more maintainable and reducing the risk of incorrect modifications during maintenance.
81 lines
2.1 KiB
Go
81 lines
2.1 KiB
Go
package ctrld_library
|
|
|
|
import (
|
|
"github.com/Control-D-Inc/ctrld/cmd/cli"
|
|
)
|
|
|
|
// Controller holds global state
|
|
type Controller struct {
|
|
stopCh chan struct{}
|
|
AppCallback AppCallback
|
|
Config cli.AppConfig
|
|
}
|
|
|
|
// NewController provides reference to global state to be managed by android vpn service and iOS network extension.
|
|
// reference is not safe for concurrent use.
|
|
func NewController(appCallback AppCallback) *Controller {
|
|
return &Controller{AppCallback: appCallback}
|
|
}
|
|
|
|
// AppCallback provides access to app instance.
|
|
type AppCallback interface {
|
|
Hostname() string
|
|
LanIp() string
|
|
MacAddress() string
|
|
Exit(error string)
|
|
}
|
|
|
|
// Start configures utility with config.toml from provided directory.
|
|
// This function will block until Stop is called
|
|
// Check port availability prior to calling it.
|
|
func (c *Controller) Start(CdUID string, HomeDir string, UpstreamProto string, logLevel int, logPath string) {
|
|
if c.stopCh == nil {
|
|
c.stopCh = make(chan struct{})
|
|
c.Config = cli.AppConfig{
|
|
CdUID: CdUID,
|
|
HomeDir: HomeDir,
|
|
UpstreamProto: UpstreamProto,
|
|
Verbose: logLevel,
|
|
LogPath: logPath,
|
|
}
|
|
appCallback := mapCallback(c.AppCallback)
|
|
cli.RunMobile(&c.Config, &appCallback, c.stopCh)
|
|
}
|
|
}
|
|
|
|
// mapCallback maps the AppCallback interface to cli.AppCallback to avoid circular dependency
|
|
func mapCallback(callback AppCallback) cli.AppCallback {
|
|
return cli.AppCallback{
|
|
HostName: func() string {
|
|
return callback.Hostname()
|
|
},
|
|
LanIp: func() string {
|
|
return callback.LanIp()
|
|
},
|
|
MacAddress: func() string {
|
|
return callback.MacAddress()
|
|
},
|
|
Exit: func(err string) {
|
|
callback.Exit(err)
|
|
},
|
|
}
|
|
}
|
|
|
|
func (c *Controller) Stop(restart bool, pin int64) int {
|
|
var errorCode = 0
|
|
// Force disconnect without checking pin.
|
|
// In iOS restart is required if vpn detects no connectivity after network change.
|
|
if !restart {
|
|
errorCode = cli.CheckDeactivationPin(pin, c.stopCh)
|
|
}
|
|
if errorCode == 0 && c.stopCh != nil {
|
|
close(c.stopCh)
|
|
c.stopCh = nil
|
|
}
|
|
return errorCode
|
|
}
|
|
|
|
func (c *Controller) IsRunning() bool {
|
|
return c.stopCh != nil
|
|
}
|