Add comprehensive library usage support and fix timeout issue #8 #32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add library.go with simple, user-friendly API functions: - QuickPortCheck() for simple port checking - IsHostUp() for host reachability testing - SimpleConnectScan() and SimpleSynScan() for basic scanning - ScanCommonPorts() for scanning standard ports - NewScannerFromConfig() for custom configurations - Add LibraryConfig struct for easy scanner configuration - Fix timeout parameter issue: provide proper time.Duration conversion - Add comprehensive examples in examples/library_usage.go - Add detailed library usage tests in scan/library_test.go - Add LIBRARY_USAGE.md with troubleshooting guide - Update README.md with library usage documentation This fixes the issue reported in liamg#8 where users got 'Host is down' when using the library due to incorrect timeout parameter handling. The timeout was being interpreted as nanoseconds instead of milliseconds. Example of the fix: // Before (broken): 6000 nanoseconds = 0.006ms timeout scanner := scan.NewConnectScanner(ti, 6000, 1000) // After (fixed): 6000 milliseconds = 6s timeout timeout := time.Duration(6000) * time.Millisecond scanner := scan.NewConnectScanner(ti, timeout, 1000) // Or use the new simple API: results, err := scan.SimpleConnectScanWithTimeout('target', ports, 6000) Fixes liamg#8
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes the issue reported in #8 where users got 'Host is down' when using the library due to incorrect timeout parameter handling. The timeout was being interpreted as nanoseconds instead of milliseconds.
Example of the fix:
// Before (broken): 6000 nanoseconds = 0.006ms timeout scanner := scan.NewConnectScanner(ti, 6000, 1000)
// After (fixed): 6000 milliseconds = 6s timeout
timeout := time.Duration(6000) * time.Millisecond
scanner := scan.NewConnectScanner(ti, timeout, 1000)
// Or use the new simple API:
results, err := scan.SimpleConnectScanWithTimeout('target', ports, 6000)
Fixes #8