summaryrefslogtreecommitdiff
path: root/toxcore
diff options
context:
space:
mode:
authorirungentoo <irungentoo@gmail.com>2014-07-14 18:36:26 -0400
committerirungentoo <irungentoo@gmail.com>2014-07-14 18:36:26 -0400
commit59821d6a5ef5b298a66feaaca337e71e9cecab61 (patch)
tree1c92cc997009221c925a6412e96c58a0819c69cc /toxcore
parent32ed095d7271a311a89d1430610e3adb4568ce2c (diff)
Fixed file sending documentation.
Diffstat (limited to 'toxcore')
-rw-r--r--toxcore/tox.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h
index b44648fc..14426f31 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -495,20 +495,20 @@ uint32_t tox_get_chatlist(const Tox *tox, int *out_list, uint32_t list_size);
495 * tox_file_data_remaining(...) can be used to know how many bytes are left to send/receive. 495 * tox_file_data_remaining(...) can be used to know how many bytes are left to send/receive.
496 * 496 *
497 * If the connection breaks during file sending (The other person goes offline without pausing the sending and then comes back) 497 * If the connection breaks during file sending (The other person goes offline without pausing the sending and then comes back)
498 * the receiver must send a control packet with receive_send == 0 message_id = TOX_FILECONTROL_RESUME_BROKEN and the data being 498 * the receiver must send a control packet with send_receive == 1 message_id = TOX_FILECONTROL_RESUME_BROKEN and the data being
499 * a uint64_t (in host byte order) containing the number of bytes received. 499 * a uint64_t (in host byte order) containing the number of bytes received.
500 * 500 *
501 * If the sender receives this packet, he must send a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_ACCEPT 501 * If the sender receives this packet, he must send a control packet with send_receive == 0 and control_type == TOX_FILECONTROL_ACCEPT
502 * then he must start sending file data from the position (data , uint64_t in host byte order) received in the TOX_FILECONTROL_RESUME_BROKEN packet. 502 * then he must start sending file data from the position (data , uint64_t in host byte order) received in the TOX_FILECONTROL_RESUME_BROKEN packet.
503 * 503 *
504 * To pause a file transfer send a control packet with control_type == TOX_FILECONTROL_PAUSE. 504 * To pause a file transfer send a control packet with control_type == TOX_FILECONTROL_PAUSE.
505 * To unpause a file transfer send a control packet with control_type == TOX_FILECONTROL_ACCEPT. 505 * To unpause a file transfer send a control packet with control_type == TOX_FILECONTROL_ACCEPT.
506 * 506 *
507 * If you receive a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_PAUSE, you must stop sending filenumber until the other 507 * If you receive a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_PAUSE, you must stop sending filenumber until the other
508 * person sends a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_ACCEPT with the filenumber being a paused filenumber. 508 * person sends a control packet with send_receive == 0 and control_type == TOX_FILECONTROL_ACCEPT with the filenumber being a paused filenumber.
509 * 509 *
510 * If you receive a control packet with receive_send == 0 and control_type == TOX_FILECONTROL_PAUSE, it means the sender of filenumber has paused the 510 * If you receive a control packet with receive_send == 0 and control_type == TOX_FILECONTROL_PAUSE, it means the sender of filenumber has paused the
511 * transfer and will resume it later with a control packet with receive_send == 0 and control_type == TOX_FILECONTROL_ACCEPT for that file number. 511 * transfer and will resume it later with a control packet with send_receive == 1 and control_type == TOX_FILECONTROL_ACCEPT for that file number.
512 * 512 *
513 * More to come... 513 * More to come...
514 */ 514 */