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.
32 lines
755 B
Go
32 lines
755 B
Go
package cli
|
|
|
|
// semaphore provides a simple synchronization mechanism
|
|
type semaphore interface {
|
|
acquire()
|
|
release()
|
|
}
|
|
|
|
// noopSemaphore is a no-operation implementation of semaphore
|
|
type noopSemaphore struct{}
|
|
|
|
// acquire performs a no-operation for the noop semaphore
|
|
func (n noopSemaphore) acquire() {}
|
|
|
|
// release performs a no-operation for the noop semaphore
|
|
func (n noopSemaphore) release() {}
|
|
|
|
// chanSemaphore is a channel-based implementation of semaphore
|
|
type chanSemaphore struct {
|
|
ready chan struct{}
|
|
}
|
|
|
|
// acquire blocks until a slot is available in the semaphore
|
|
func (c *chanSemaphore) acquire() {
|
|
c.ready <- struct{}{}
|
|
}
|
|
|
|
// release signals that a slot has been freed in the semaphore
|
|
func (c *chanSemaphore) release() {
|
|
<-c.ready
|
|
}
|