summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorirungentoo <irungentoo@gmail.com>2014-12-03 19:39:08 -0500
committerirungentoo <irungentoo@gmail.com>2014-12-03 19:39:08 -0500
commitf1db6e7d6cb94584fbe03a30aebca36666b6e033 (patch)
tree4ca2546baa929f99a3f1f9870f28fb892f5d3b7e /docs
parent4994d28f9b8c29921718b0417abeaea81e21004c (diff)
parent3489e330107c07e31d35daefed0566c9545b6a99 (diff)
Merge branch 'patch-2' of https://github.com/Aaron1011/toxcore
Diffstat (limited to 'docs')
-rw-r--r--docs/Avatars.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/Avatars.md b/docs/Avatars.md
index d96e41d3..3e3fa93a 100644
--- a/docs/Avatars.md
+++ b/docs/Avatars.md
@@ -246,7 +246,7 @@ Given the Tox data directory described in STS Draft v0.1.0:
246 address!) encoded as an uppercase hexadecimal string and "png" is the 246 address!) encoded as an uppercase hexadecimal string and "png" is the
247 extension for the PNG avatar. As new image formats may be used in the 247 extension for the PNG avatar. As new image formats may be used in the
248 future, clients should ensure no other file "xxxxx.*" exists. No file 248 future, clients should ensure no other file "xxxxx.*" exists. No file
249 should be kept for an user who have no avatar. 249 should be kept for a user who has no avatar.
250 250
251 - The client's own avatar is not special and is stored like any other. This 251 - The client's own avatar is not special and is stored like any other. This
252 is partially for simplicity, and partially in anticipation of profiles. 252 is partially for simplicity, and partially in anticipation of profiles.
@@ -368,7 +368,7 @@ checks the local avatar cache and emits an avatar data request if necessary:
368 printf("Receiving avatar information from friend %d. Format = %d\n", 368 printf("Receiving avatar information from friend %d. Format = %d\n",
369 friendnumber, format); 369 friendnumber, format);
370 if (format = TOX_AVATAR_FORMAT_NONE) { 370 if (format = TOX_AVATAR_FORMAT_NONE) {
371 /* User have no avatar or removed the avatar */ 371 /* User has no avatar or removed the avatar */
372 delete_avatar_from_cache(tox, friendnumber); 372 delete_avatar_from_cache(tox, friendnumber);
373 } else { 373 } else {
374 /* Use the received hash to check if the cached avatar is 374 /* Use the received hash to check if the cached avatar is
@@ -388,7 +388,7 @@ cache:
388 uint8_t *hash, uint8_t *data, uint32_t datalen, void *userdata) 388 uint8_t *hash, uint8_t *data, uint32_t datalen, void *userdata)
389 { 389 {
390 if (format = TOX_AVATAR_FORMAT_NONE) { 390 if (format = TOX_AVATAR_FORMAT_NONE) {
391 /* User have no avatar or removed the avatar */ 391 /* User has no avatar or removed the avatar */
392 delete_avatar_from_cache(tox, friendnumber); 392 delete_avatar_from_cache(tox, friendnumber);
393 } else { 393 } else {
394 save_avatar_data_to_cache(tox, friendnumber, format, hash, 394 save_avatar_data_to_cache(tox, friendnumber, format, hash,
@@ -439,7 +439,7 @@ The avatar transfer protocol adds the following new packet types and ids:
439### Requesting avatar information 439### Requesting avatar information
440 440
441To request avatar information, an user must send a packet of type 441To request avatar information, an user must send a packet of type
442`PACKET_ID_AVATAR_INFO_REQ`. This packet have no data fields. Upon 442`PACKET_ID_AVATAR_INFO_REQ`. This packet has no data fields. Upon
443receiving this packet, a client which supports avatars should answer with 443receiving this packet, a client which supports avatars should answer with
444a `PACKET_ID_AVATAR_INFO`. The sender must accept that the friend may 444a `PACKET_ID_AVATAR_INFO`. The sender must accept that the friend may
445not answer at all. 445not answer at all.
@@ -503,7 +503,7 @@ types.
503 is the total number of bytes the raw avatar data. 503 is the total number of bytes the raw avatar data.
504 504
505 505
506 - Packet `PACKET_ID_AVATAR_DATA_PUSH` have no format structure, just up 506 - Packet `PACKET_ID_AVATAR_DATA_PUSH` has no format structure, just up
507 to `AVATAR_DATA_MAX_CHUNK_SIZE` bytes of raw avatar image data; this 507 to `AVATAR_DATA_MAX_CHUNK_SIZE` bytes of raw avatar image data; this
508 value is defined according to the maximum amount of data a Tox crypted 508 value is defined according to the maximum amount of data a Tox crypted
509 packet can hold. 509 packet can hold.
@@ -521,7 +521,7 @@ from a client "B":
521 - If "B" accepts this transfer, it answers by sending an 521 - If "B" accepts this transfer, it answers by sending an
522 `PACKET_ID_AVATAR_DATA_START` with the fields 'format', 'hash' and 522 `PACKET_ID_AVATAR_DATA_START` with the fields 'format', 'hash' and
523 'data_length' set to the respective values from the current avatar. 523 'data_length' set to the respective values from the current avatar.
524 If "B" have no avatar set, 'format' must be `AVATAR_FORMAT_NONE`, 'hash' 524 If "B" has no avatar set, 'format' must be `AVATAR_FORMAT_NONE`, 'hash'
525 must be zeroed and 'data_length' must be zero. 525 must be zeroed and 'data_length' must be zero.
526 526
527 If "B" does not accept sending the avatar, it may send a packet 527 If "B" does not accept sending the avatar, it may send a packet