Skip to content
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

feat!: lib API improvements #21

Merged
merged 3 commits into from
Aug 10, 2022
Merged

feat!: lib API improvements #21

merged 3 commits into from
Aug 10, 2022

Conversation

kffl
Copy link
Owner

@kffl kffl commented Aug 10, 2022

This PR implements lib API improvements as described in #20.

Changes made to the lib API:

  • Start() is no longer blocking. It will either unblock as soon as the proxy starts listening or return an error if proxy startup fails;
  • Stop() waits for all proxy connections to close before returning.

Resolves #20

BREAKING CHANGE: Start() is no longer blocking, Stop() waits for all proxy connections to close before returning. Refer to the upgrade guide in the `lib` package README for additional details.
@kffl kffl added this to the v1 Release milestone Aug 10, 2022
@kffl kffl changed the title feat: lib API improvements feat!: lib API improvements Aug 10, 2022
@kffl kffl merged commit a4e38c6 into master Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

lib API improvements
1 participant