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

Reverse engineer the current Assimilation protocol and create a README or other document describing it #3

Open
Alan-R opened this issue Nov 20, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Alan-R
Copy link
Owner

Alan-R commented Nov 20, 2023

Of course, reverse engineering open source software with some existing documents isn’t as hard as most reverse engineering wink.

The top level document for this activity is in the project wiki. It draws from two previous articles written long ago:

Although these are not enough, they provide great fodder for how it works in some aspects.
They lack on explaining how startup and shutdown occur.

@Alan-R Alan-R added the documentation Improvements or additions to documentation label Nov 20, 2023
@Alan-R Alan-R self-assigned this Nov 20, 2023
@Alan-R
Copy link
Owner Author

Alan-R commented Nov 21, 2023

Making good progress. Most of the sections of the document have been completed at least to a first draft stage.
The section that remains is to complete the state diagram for managing connections, and a page on packet retransmission.
The state diagram section can only be drawn from the code, as the older documents don't cover that aspect.
This is pretty critical stuff, as a lot of practical experience is embodied in that state machine.

@Alan-R
Copy link
Owner Author

Alan-R commented Nov 23, 2023

Added a page on packet retransmission.

@Alan-R
Copy link
Owner Author

Alan-R commented Nov 26, 2023

I believe that this documentation is "good enough for the intended purpose". The only thing really lacking is the action table in the FSA. When writing the new code, the C code should be referenced, not the documentation.

@Alan-R
Copy link
Owner Author

Alan-R commented Nov 26, 2023

Waiting for a review from @borgified or @Greg-2600 or @lclaudio.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant