Leahnaya/gba-link-connection
1
0
Fork 0
mirror of https://github.com/afska/gba-link-connection.git synced 2026-10-01 13:27:18 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updating asyncACKTimerId docs

Browse Source
This commit is contained in:
Rodrigo Alfonso
2024-08-27 01:20:34 -03:00
parent bdd3de84b3
commit d97a104f34
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -199,7 +199,7 @@ Name | Type | Default | Description
`timeout` | **u32** | `10` | Maximum number of *frames* without receiving data from other player before resetting the connection.
`interval` | **u16** | `50` | Number of *1024-cycle ticks* (61.04μs) between transfers *(50 = 3.052ms)*. It's the interval of Timer #`sendTimerId`. Lower values will transfer faster but also consume more CPU. You can use `Link::perFrame(...)` to convert from *packets per frame* to *interval values*.
`sendTimerId` | **u8** *(0~3)* | `3` | GBA Timer to use for sending.
`asyncACKTimerId` | **s8** *(0~3 or -1)* | `-1` | GBA Timer to use for ACKs. If you have free timers, use one here to reduce CPU usage.
`asyncACKTimerId` | **s8** *(0~3 or -1)* | `-1` | This GBA timer is used to asynchronously acknowledge the adapter transfers. It is disabled by default, with the acknowledgment procedure performed during SERIAL interrupts.
You can update these values at any time without creating a new instance:
- Call `deactivate()`.

5
lib/LinkWireless.hpp
View File

@@ -304,8 +304,9 @@ class LinkWireless {
* *(50 = 3.052ms)*. It's the interval of Timer #`sendTimerId`. Lower values
* will transfer faster but also consume more CPU.
* @param sendTimerId GBA Timer to use for sending.
* @param asyncACKTimerId GBA Timer to use for ACKs. If you have free timers,
* use one here to reduce CPU usage.
* @param asyncACKTimerId This GBA timer is used to asynchronously acknowledge
* the adapter transfers. It is disabled by default, with the acknowledgment
* procedure performed during SERIAL interrupts.
* \warning You can use `Link::perFrame(...)` to convert from *packets per
* frame* to *interval values*.
*/