StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Amend comments to reflect undefined filenumber and friendnumber behavior

Browse Source
This commit is contained in:
Jfreegman 2015-03-31 19:43:44 -04:00
parent 4e94a45af2
commit c7276ac7bb
No known key found for this signature in database
GPG Key ID: 3627F3144076AE63
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
toxcore/tox.h
View File

@ -881,7 +881,8 @@ typedef enum TOX_ERR_FRIEND_ADD {
* friends. Once added, a friend number is stable for the lifetime of the Tox
* object. After saving the state and reloading it, the friend numbers may not
* be the same as before. Deleting a friend creates a gap in the friend number
* set, which is filled by the next adding of a friend.
* set, which is filled by the next adding of a friend. Any pattern in friend
* numbers should not be relied on.
*
* If more than INT32_MAX friends are added, this function causes undefined
* behaviour.
@ -1660,7 +1661,8 @@ typedef enum TOX_ERR_FILE_SEND {
*
* @return A file number used as an identifier in subsequent callbacks. This
* number is per friend. File numbers are reused after a transfer terminates.
* on failure, this function returns UINT32_MAX.
* on failure, this function returns UINT32_MAX. Any pattern in file numbers
* should not be relied on.
*/
uint32_t tox_file_send(Tox *tox, uint32_t friend_number, uint32_t kind, uint64_t file_size, const uint8_t *file_id,
const uint8_t *filename, size_t filename_length, TOX_ERR_FILE_SEND *error);