AlexStocks / getty

a netty like asynchronous network I/O library based on tcp/udp/websocket; a bidirectional RPC framework based on JSON/Protobuf; a microservice framework based on zookeeper/etcd
Apache License 2.0
883 stars 184 forks source link

Improvement: rename the variables in TCP reconnect function and some default constants #84

Open No-SilverBullet opened 3 weeks ago

No-SilverBullet commented 3 weeks ago

What this PR does:

rename the variables in TCP reconnect function and some default constants.

1.rename constant 'reconnectInterval' to defaultReconnectInterval and 'maxTimes' to defaultMaxReconnectAttempts, indicates that these two constants are the default settings.

2.rename vars in reConnect():

Which issue(s) this PR fixes: NONE

Special notes for your reviewer: NONE Does this PR introduce a user-facing change?:

Add new client-side attribute 'maxReconnectAttempts' to represent the max reconnect attempts in maintaining the tcp connetion pool size, the default value is setted to 100.

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes made across multiple files in the repository involve enhancements and adjustments to the TCP client connection management, specifically regarding the reconnection logic. This includes renaming and reorganizing constants, updating the reconnection function to use new parameters, adding support for maximum reconnect attempts, refining error handling for setting deadlines, and adjusting configuration and initialization to support these new options.

Changes

File Path Change Summary
transport/client.go Reorganized constants, updated reconnection logic, and refactored variables for clarity in reconnection attempts.
transport/options.go Added maxReconnectAttempts field in ClientOptions, and introduced the WithReconnectAttempts option.
transport/session.go Improved stop() method to separately handle and log errors for setting connection read and write deadlines.
examples/echo/tcp-echo/client/app/config.go Added TcpMaxReconnectAttempts field to GettySessionParam.
examples/echo/tcp-echo/client/app/main.go Updated initClient function to include getty.WithReconnectAttempts option based on new configuration.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant Server as Server
    participant Config as Config
    participant Logger as Logger

    Client->>Config: Load GettySessionParam
    Config-->>Client: TcpMaxReconnectAttempts
    Client->>Server: Connect
    alt Successful Connection
        Server-->>Client: Acknowledge
    else Connection Fails
        Client->>Logger: Log Connection Failed
        loop MaxReconnectAttempts
            Client->>Server: Reconnect Attempt
            alt Connection Successful
                Server-->>Client: Acknowledge
                break
            else Connection Fails
                Client->>Logger: Log Failed Attempt
            end
        end
        Server-->>Client: Max Attempts Reached
    end
    Client->>Logger: Log Final Status

Poem

In circuits of code, we strive and connect, Reaching out again when paths are wrecked. With constants anew and errors confined, TCP whispers, a dance so refined. Retry, reconnect, with grace we align, Ensuring the data flows, every time.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Lvnszn commented 2 weeks ago

@AlexStocks 雨哥,看着 reconnect 那边的逻辑其实可以加个 issue,太多参数都是临时变量,不利于维护。其实变成 client 里面的参数会更好一点。

No-SilverBullet commented 2 weeks ago

@AlexStocks 雨哥,看着 reconnect 那边的逻辑其实可以加个 issue,太多参数都是临时变量,不利于维护。其实变成 client 里面的参数会更好一点。

我把里面的一些变量调整为短变量申明的方式,这样看上去可能会好一点。然后除了maxReconnectAttempts(这个参数是client-side需要关心的参数,其他都不需要放到client里)