-
Notifications
You must be signed in to change notification settings - Fork 158
Unify connection pool behavior, update read parameter, remove tag management from API, resolve stream cutoff issues #68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
…close signal mechanism
…ogic with updated docs
… error logging to warning
…ommonTCP/UDP loops
… refactor cleanup logic in commonUDPOnce
…nection reliability
…althCheck to use it
…op, commonTCPOnce, and commonUDPOnce
…rites in healthCheck and loop functions
…POnce using context
…in common tcp udp loop and once
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 pull request makes substantial changes to both the English (
docs/en/api.md,docs/en/configuration.md) and Chinese (docs/zh/api.md,docs/zh/configuration.md) documentation for the NodePass API and configuration. The most important changes are the complete removal of tag management functionality and documentation from the API, and a significant update to the description and usage of thereadparameter to clarify its dual role in both data read timeout and connection reuse. Additionally, several default values and configuration details have been updated for accuracy.API Documentation Changes
Tag Management Removal
PATCH Endpoint Simplification
/instances/{id}endpoint documentation now only allows updating state, alias, and restart policy, removing support for tag operations. Example requests have been updated accordingly. [1] [2]Auto-Start Policy Logic Update
criticalboolean field, instead of checking for acriticaltag in the tags array. [1] [2]Configuration Documentation Changes
readParameter Redefinition and Expansionreadparameter has been rewritten to clarify that it now controls both data read timeout and connection pool reuse. The default is now0(no timeout, no connection recycling), and positive values enable both timeout and connection reuse. Several examples and use cases have been added to illustrate this behavior. [1] [2]Configuration Table Updates
readparameter.Environment Variable Defaults
NP_TCP_DATA_BUF_SIZEhas been changed from32768to16384, and forNP_POOL_GET_TIMEOUTfrom30sto5s, to better reflect current recommended settings.These changes remove all tag management features from the documentation, clarify the behavior of the
readparameter for connection reuse, and update configuration defaults to match current best practices.