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

Proposal - Readability Improvement - Avoid rename of aws-c-io functions #358

Closed
cobookman opened this issue Jan 17, 2022 · 2 comments
Closed
Assignees
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue

Comments

@cobookman
Copy link

Proposal

Changing these lines in connection_manager.c#L44-L51

static struct aws_http_connection_manager_system_vtable s_default_system_vtable = {
    .create_connection = aws_http_client_connect,
    .release_connection = aws_http_connection_release,
    .close_connection = aws_http_connection_close,
    .is_connection_available = aws_http_connection_new_requests_allowed,
    .get_monotonic_time = aws_high_res_clock_get_ticks,
    .is_callers_thread = aws_channel_thread_is_callers_thread,
    .connection_get_channel = aws_http_connection_get_channel,
};

TO:

static struct aws_http_connection_manager_system_vtable s_default_system_vtable = {
    .aws_http_client_connect = aws_http_client_connect,
    .aws_http_connection_release = aws_http_connection_release,
    .aws_http_connection_close = aws_http_connection_close,
    .aws_http_connection_new_requests_allowed = aws_http_connection_new_requests_allowed,
    .aws_high_res_clock_get_ticks = aws_high_res_clock_get_ticks,
    .aws_channel_thread_is_callers_thread = aws_channel_thread_is_callers_thread,
    .aws_http_connection_get_channel = aws_http_connection_get_channel,
};

Rational:

Improve readability of the codebase and make it easier to understand call paths between aws-c-http and aws-c-io.

The current renaming of functions makes it difficult to parse function call paths and to perform searches for where aws_http_* is being invoked across the aws c/cpp SDKs.

@yasminetalby yasminetalby added feature-request A feature should be added or improved. needs-review This issue or pull request needs review from a core team member. labels Jun 23, 2023
@yasminetalby yasminetalby self-assigned this Sep 20, 2023
@yasminetalby yasminetalby added the p3 This is a minor priority issue label Sep 20, 2023
@yasminetalby
Copy link
Contributor

Hello @cobookman ,

Thank you very much for your submission and feedback.
My apologies for the delay of answer on this issue. We are open to this change if you would like to make a PR for it!

Best regards,

Yasmine

@yasminetalby yasminetalby added response-requested Waiting on additional info and feedback. Will move to 'closing-soon' in 7 days. and removed needs-review This issue or pull request needs review from a core team member. labels Sep 21, 2023
@graebm graebm removed the response-requested Waiting on additional info and feedback. Will move to 'closing-soon' in 7 days. label Sep 26, 2023
@graebm
Copy link
Contributor

graebm commented Sep 26, 2023

Done

@graebm graebm closed this as completed Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

3 participants