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

Rename API entities to enhance compliance with the spec #98

Closed
pavel-kirienko opened this issue Mar 24, 2019 · 3 comments
Closed

Rename API entities to enhance compliance with the spec #98

pavel-kirienko opened this issue Mar 24, 2019 · 3 comments
Milestone

Comments

@pavel-kirienko
Copy link
Member

  • canardEncodeScalar --> canardEncodePrimitive
  • canardDecodeScalar --> canardDecodePrimitive
  • CanardTransferTypeResponse --> CanardTransferTypeServiceResponse
  • CanardTransferTypeRequest --> CanardTransferTypeServiceRequest
  • CanardTransferTypeBroadcast --> CanardTransferTypeMessagePublication
  • canardBroadcast --> canardPublishMessage
@pavel-kirienko
Copy link
Member Author

From #99:

The function "canardCleanupStaleTransfers()" must be removed (this affects the API and the demo); see section 4.2.1 for details. This change to the spec was implemented in order to improve deterministic behavior at the cost of somewhat increased average-case memory usage (the worst case is unaffected). The constant CANARD_RECOMMENDED_STALE_TRANSFER_CLEANUP_INTERVAL_USEC is therefore not needed either (there could be other constants which we no longer need).

Data type signature must be removed from everywhere. This includes the callback signature CanardShouldAcceptTransfer.

The API functions still use "data type ID" instead of "subject ID" and "service ID", this should be fixed.

The transfer priority constants require updating. We have proper mnemonic names for the eight priority levels defined in 4.1.4.

The script show_data_type_info.py will no longer be needed, since there are no signatures to worry about.

@aasmune
Copy link
Contributor

aasmune commented Mar 28, 2019

I have started working on this now but will wait to commit/push until #99 is merged.

@aasmune
Copy link
Contributor

aasmune commented Mar 31, 2019

Fixed in #106

@aasmune aasmune closed this as completed Mar 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants