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

Design Transport Interface API #48

Closed
mdabrowski1990 opened this issue Aug 14, 2021 · 0 comments · Fixed by #156
Closed

Design Transport Interface API #48

mdabrowski1990 opened this issue Aug 14, 2021 · 0 comments · Fixed by #156
Assignees
Labels
implementation Changes to code

Comments

@mdabrowski1990
Copy link
Owner

mdabrowski1990 commented Aug 14, 2021

Requires

#85

Description

As a user, I would like to have Transport Interface API defined, so I have interface to use UDS Packets.
As a developer, I would like to have AbstractTransportInterface class with methods (annotated with descriptions) defined, so I know what has to be implemented and what functionalities would be provided in this milestrone.

Acceptance Criteria

  • AbstractTransportInterface class is defined
  • Each method of AbstractTransportInterface class has annotation and description.
  • Transport Interface methods are defined to provide following functionalities:
    • Configuration
      • setting all required parameters at object creation
      • possibility to read all configured parameters
      • timeout values and bus configuration must be stored and accessable by the object
      • only setable parameters can be changed after Transport Interface object is created
    • Transmission:
      • Scheduling transmission of UDS Packets in certain moments of time
    • Receiving:
      • receiving packets when the object is alive
      • receiving is done in the background (async)
    • Storage:
      • storage for all packet that were transmitted
      • storage for all packet that were received
@mdabrowski1990 mdabrowski1990 added the documentation Improvements or additions to documentation label Aug 14, 2021
@mdabrowski1990 mdabrowski1990 modified the milestones: First release - basic functionality, Client Simulation Aug 15, 2021
@mdabrowski1990 mdabrowski1990 changed the title Abstract Transport Interface refinement Transport Interface design Aug 20, 2021
@mdabrowski1990 mdabrowski1990 modified the milestones: 2) Client Simulation, Server Simulation Aug 20, 2021
@mdabrowski1990 mdabrowski1990 added the implementation Changes to code label Aug 20, 2021
@mdabrowski1990 mdabrowski1990 modified the milestones: X) Client Simulation, 2) Basic client support for CAN Sep 6, 2021
@mdabrowski1990 mdabrowski1990 changed the title Transport Interface design [refine] Design Transport Interface Sep 7, 2021
@mdabrowski1990 mdabrowski1990 removed the documentation Improvements or additions to documentation label Sep 7, 2021
@mdabrowski1990 mdabrowski1990 changed the title [refine] Design Transport Interface Design Transport Interface Sep 7, 2021
@mdabrowski1990 mdabrowski1990 changed the title Design Transport Interface Design Transport Interface API Sep 7, 2021
@mdabrowski1990 mdabrowski1990 changed the title Design Transport Interface API [refine] Design Transport Interface API Dec 6, 2021
@mdabrowski1990 mdabrowski1990 changed the title [refine] Design Transport Interface API Design Transport Interface API Dec 6, 2021
@mdabrowski1990 mdabrowski1990 changed the title Design Transport Interface API [refine] Design Transport Interface API Dec 7, 2021
@mdabrowski1990 mdabrowski1990 changed the title [refine] Design Transport Interface API Design Transport Interface API Dec 7, 2021
@mdabrowski1990 mdabrowski1990 self-assigned this Dec 28, 2021
@mdabrowski1990 mdabrowski1990 linked a pull request Dec 29, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
implementation Changes to code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant