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

[Feature Request] Standardize Function Naming Conventions #1069

Closed
HTRamsey opened this issue Dec 30, 2023 · 2 comments
Closed

[Feature Request] Standardize Function Naming Conventions #1069

HTRamsey opened this issue Dec 30, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@HTRamsey
Copy link
Contributor

The function naming conventions should be more universal, such as with capitalization in the case of FreeRTOS_SignalSocket vs FreeRTOS_closesocket. I would suggest renaming as needed for next major version and include macros to link to the old names.

Also there are some functions such as xSocketSetSocketID/pvSocketGetSocketID which state are only used by the user but don't have the API naming convention.

@HTRamsey HTRamsey changed the title [Feature Request] Standardize API Function Naming Convention [Feature Request] Standardize Function Naming Conventions Dec 30, 2023
@aggarg
Copy link
Member

aggarg commented Jan 8, 2024

Thank you @HTRamsey for your suggestion. We will keep it in mind for next major release.

@aggarg aggarg added the enhancement New feature or request label Jan 8, 2024
@htibosch
Copy link
Contributor

htibosch commented Jan 8, 2024

@HTRamsey wrote:

The function naming conventions should be more universal, such as with capitalization in the case of FreeRTOS_SignalSocket vs FreeRTOS_closesocket.

The function FreeRTOS_SignalSocket is using Camel case because there is not a corresponding signalsocket(), although the function signal() is quite similar: it can interrupt an API.

All BSD functions are in small letters and preceded by FreeRTOS_, such as FreeRTOS_bind().

@HTRamsey HTRamsey closed this as completed Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants