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

Add additional documentation #3

Open
9 of 13 tasks
mucaho opened this issue Sep 13, 2014 · 0 comments
Open
9 of 13 tasks

Add additional documentation #3

mucaho opened this issue Sep 13, 2014 · 0 comments

Comments

@mucaho
Copy link
Owner

mucaho commented Sep 13, 2014

Add documentation:

  • explain ProtocolListener.handleUnordered better (it's actually unreceived data that gets skipped over, the argument is the first data after the "gap")
  • document jnetrobust-samples
  • document Packet & MetaData
  • rename MetaData to Segment, to be in line with ISO/OSI terminology analogue to Packet, update Wiki
  • document non API classes
  • explain Config values better and which listener gets called once constraint violated
  • explain Protocol empty ack transmission requirement better. Use RTT and packet send rate.
  • add pseudocode diagram for using protocol methods
  • move javadoc to github pages
  • give overview of project in readme file
  • provide API overview in wiki
  • document that user is required to send ACK immediately with empty transmission, unless he is sending packets at fixed intervals < 100 ms
  • inform user that if he uses protocol without retransmission, he should adapt config values to be more aggressive so he is informed a lot quicker about lost/unordered packets -> 16 should be fine
@mucaho mucaho changed the title Add documentation Add additional documentation Oct 22, 2014
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

1 participant