summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
Diffstat (limited to 'core')
-rw-r--r--core/CMakeLists.txt3
-rw-r--r--core/Messenger.h31
-rw-r--r--core/network.c43
-rw-r--r--core/network.h10
-rw-r--r--core/tox.c374
-rw-r--r--core/tox.h289
6 files changed, 685 insertions, 65 deletions
diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
index 02a42849..49ca7c83 100644
--- a/core/CMakeLists.txt
+++ b/core/CMakeLists.txt
@@ -10,7 +10,8 @@ set(core_sources
10 LAN_discovery.c 10 LAN_discovery.c
11 Messenger.c 11 Messenger.c
12 util.c 12 util.c
13 ping.c) 13 ping.c
14 tox.c)
14 15
15set(core_headers 16set(core_headers
16 DHT.h 17 DHT.h
diff --git a/core/Messenger.h b/core/Messenger.h
index 581c4ba9..e808529f 100644
--- a/core/Messenger.h
+++ b/core/Messenger.h
@@ -48,23 +48,28 @@ extern "C" {
48#define PACKET_ID_MESSAGE 64 48#define PACKET_ID_MESSAGE 64
49#define PACKET_ID_ACTION 63 49#define PACKET_ID_ACTION 63
50 50
51
51/* status definitions */ 52/* status definitions */
52#define FRIEND_ONLINE 4 53enum {
53#define FRIEND_CONFIRMED 3 54 NOFRIEND,
54#define FRIEND_REQUESTED 2 55 FRIEND_ADDED,
55#define FRIEND_ADDED 1 56 FRIEND_REQUESTED,
56#define NOFRIEND 0 57 FRIEND_CONFIRMED,
58 FRIEND_ONLINE,
59};
57 60
58/* errors for m_addfriend 61/* errors for m_addfriend
59 * FAERR - Friend Add Error */ 62 * FAERR - Friend Add Error */
60#define FAERR_TOOLONG -1 63enum {
61#define FAERR_NOMESSAGE -2 64 FAERR_TOOLONG = -1,
62#define FAERR_OWNKEY -3 65 FAERR_NOMESSAGE = -2,
63#define FAERR_ALREADYSENT -4 66 FAERR_OWNKEY = -3,
64#define FAERR_UNKNOWN -5 67 FAERR_ALREADYSENT = -4,
65#define FAERR_BADCHECKSUM -6 68 FAERR_UNKNOWN = -5,
66#define FAERR_SETNEWNOSPAM -7 69 FAERR_BADCHECKSUM = -6,
67#define FAERR_NOMEM -8 70 FAERR_SETNEWNOSPAM = -7,
71 FAERR_NOMEM = -8
72};
68 73
69/* don't assume MAX_STATUSMESSAGE_LENGTH will stay at 128, it may be increased 74/* don't assume MAX_STATUSMESSAGE_LENGTH will stay at 128, it may be increased
70 to an absurdly large number later */ 75 to an absurdly large number later */
diff --git a/core/network.c b/core/network.c
index 7880eae6..2bcf7d61 100644
--- a/core/network.c
+++ b/core/network.c
@@ -144,8 +144,9 @@ static void at_shutdown(void)
144 returns NULL if there are problems */ 144 returns NULL if there are problems */
145Networking_Core *new_networking(IP ip, uint16_t port) 145Networking_Core *new_networking(IP ip, uint16_t port)
146{ 146{
147 if(at_startup() != 0) 147 if (at_startup() != 0)
148 return NULL; 148 return NULL;
149
149 /* initialize our socket */ 150 /* initialize our socket */
150 Networking_Core *temp = calloc(1, sizeof(Networking_Core)); 151 Networking_Core *temp = calloc(1, sizeof(Networking_Core));
151 152
@@ -215,43 +216,3 @@ void kill_networking(Networking_Core *net)
215 free(net); 216 free(net);
216 return; 217 return;
217} 218}
218
219/*
220 resolve_addr():
221 address should represent IPv4 or a hostname with A record
222
223 returns a data in network byte order that can be used to set IP.i or IP_Port.ip.i
224 returns 0 on failure
225
226 TODO: Fix ipv6 support
227*/
228uint32_t resolve_addr(const char *address)
229{
230 struct addrinfo *server = NULL;
231 struct addrinfo hints;
232 int rc;
233 uint32_t addr;
234
235 memset(&hints, 0, sizeof(hints));
236 hints.ai_family = AF_INET; // IPv4 only right now.
237 hints.ai_socktype = SOCK_DGRAM; // type of socket Tox uses.
238
239 rc = getaddrinfo(address, "echo", &hints, &server);
240
241 // Lookup failed.
242 if (rc != 0) {
243 return 0;
244 }
245
246 // IPv4 records only..
247 if (server->ai_family != AF_INET) {
248 freeaddrinfo(server);
249 return 0;
250 }
251
252
253 addr = ((struct sockaddr_in *)server->ai_addr)->sin_addr.s_addr;
254
255 freeaddrinfo(server);
256 return addr;
257}
diff --git a/core/network.h b/core/network.h
index 088bbb3b..3547f79b 100644
--- a/core/network.h
+++ b/core/network.h
@@ -151,16 +151,6 @@ Networking_Core *new_networking(IP ip, uint16_t port);
151/* function to cleanup networking stuff(doesn't do much right now) */ 151/* function to cleanup networking stuff(doesn't do much right now) */
152void kill_networking(Networking_Core *net); 152void kill_networking(Networking_Core *net);
153 153
154/*
155 resolve_addr():
156 address should represent IPv4 or a hostname with A record
157
158 returns a data in network byte order that can be used to set IP.i or IP_Port.ip.i
159 returns 0 on failure
160
161 TODO: Fix ipv6 support
162*/
163uint32_t resolve_addr(const char *address);
164 154
165#ifdef __cplusplus 155#ifdef __cplusplus
166} 156}
diff --git a/core/tox.c b/core/tox.c
new file mode 100644
index 00000000..a97e52bc
--- /dev/null
+++ b/core/tox.c
@@ -0,0 +1,374 @@
1/* tox.c
2 *
3 * The Tox public API.
4 *
5 * Copyright (C) 2013 Tox project All Rights Reserved.
6 *
7 * This file is part of Tox.
8 *
9 * Tox is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * Tox is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with Tox. If not, see <http://www.gnu.org/licenses/>.
21 *
22 */
23
24#include "Messenger.h"
25/*
26 * returns a FRIEND_ADDRESS_SIZE byte address to give to others.
27 * format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
28 *
29 */
30void tox_getaddress(void *tox, uint8_t *address)
31{
32 Messenger *m = tox;
33 getaddress(m, address);
34}
35
36/*
37 * add a friend
38 * set the data that will be sent along with friend request
39 * address is the address of the friend (returned by getaddress of the friend you wish to add) it must be FRIEND_ADDRESS_SIZE bytes. TODO: add checksum.
40 * data is the data and length is the length
41 * returns the friend number if success
42 * return FA_TOOLONG if message length is too long
43 * return FAERR_NOMESSAGE if no message (message length must be >= 1 byte)
44 * return FAERR_OWNKEY if user's own key
45 * return FAERR_ALREADYSENT if friend request already sent or already a friend
46 * return FAERR_UNKNOWN for unknown error
47 * return FAERR_BADCHECKSUM if bad checksum in address
48 * return FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different
49 * (the nospam for that friend was set to the new one)
50 * return FAERR_NOMEM if increasing the friend list size fails
51 */
52int tox_addfriend(void *tox, uint8_t *address, uint8_t *data, uint16_t length)
53{
54 Messenger *m = tox;
55 return m_addfriend(m, address, data, length);
56}
57
58/* add a friend without sending a friendrequest.
59 returns the friend number if success
60 return -1 if failure. */
61int tox_addfriend_norequest(void *tox, uint8_t *client_id)
62{
63 Messenger *m = tox;
64 return m_addfriend_norequest(m, client_id);
65}
66
67/* return the friend id associated to that client id.
68 return -1 if no such friend */
69int tox_getfriend_id(void *tox, uint8_t *client_id)
70{
71 Messenger *m = tox;
72 return getfriend_id(m, client_id);
73}
74
75/* copies the public key associated to that friend id into client_id buffer.
76 make sure that client_id is of size CLIENT_ID_SIZE.
77 return 0 if success
78 return -1 if failure */
79int tox_getclient_id(void *tox, int friend_id, uint8_t *client_id)
80{
81 Messenger *m = tox;
82 return getclient_id(m, friend_id, client_id);
83}
84
85/* remove a friend */
86int tox_delfriend(void *tox, int friendnumber)
87{
88 Messenger *m = tox;
89 return m_delfriend(m, friendnumber);
90}
91
92/* return 4 if friend is online
93 return 3 if friend is confirmed
94 return 2 if the friend request was sent
95 return 1 if the friend was added
96 return 0 if there is no friend with that number */
97int tox_friendstatus(void *tox, int friendnumber)
98{
99 Messenger *m = tox;
100 return m_friendstatus(m, friendnumber);
101}
102
103/* send a text chat message to an online friend
104 returns the message id if packet was successfully put into the send queue
105 return 0 if it was not
106 you will want to retain the return value, it will be passed to your read receipt callback
107 if one is received.
108 m_sendmessage_withid will send a message with the id of your choosing,
109 however we can generate an id for you by calling plain m_sendmessage. */
110uint32_t tox_sendmessage(void *tox, int friendnumber, uint8_t *message, uint32_t length)
111{
112 Messenger *m = tox;
113 return m_sendmessage(m, friendnumber, message, length);
114}
115
116uint32_t tox_sendmessage_withid(void *tox, int friendnumber, uint32_t theid, uint8_t *message, uint32_t length)
117{
118 Messenger *m = tox;
119 return m_sendmessage_withid(m, friendnumber, theid, message, length);
120}
121
122/* send an action to an online friend
123 returns 1 if packet was successfully put into the send queue
124 return 0 if it was not */
125int tox_sendaction(void *tox, int friendnumber, uint8_t *action, uint32_t length)
126{
127 Messenger *m = tox;
128 return m_sendaction(m, friendnumber, action, length);
129}
130
131/* Set our nickname
132 name must be a string of maximum MAX_NAME_LENGTH length.
133 length must be at least 1 byte
134 length is the length of name with the NULL terminator
135 return 0 if success
136 return -1 if failure */
137int tox_setname(void *tox, uint8_t *name, uint16_t length)
138{
139 Messenger *m = tox;
140 return setname(m, name, length);
141}
142
143/*
144 Get your nickname.
145 m The messanger context to use.
146 name Pointer to a string for the name.
147 nlen The length of the string buffer.
148 returns Return the length of the name, 0 on error.
149*/
150uint16_t tox_getselfname(void *tox, uint8_t *name, uint16_t nlen)
151{
152 Messenger *m = tox;
153 return getself_name(m, name, nlen);
154}
155
156/* get name of friendnumber
157 put it in name
158 name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
159 return 0 if success
160 return -1 if failure */
161int tox_getname(void *tox, int friendnumber, uint8_t *name)
162{
163 Messenger *m = tox;
164 return getname(m, friendnumber, name);
165}
166
167/* set our user status
168 you are responsible for freeing status after
169 returns 0 on success, -1 on failure */
170int tox_set_statusmessage(void *tox, uint8_t *status, uint16_t length)
171{
172 Messenger *m = tox;
173 return m_set_statusmessage(m, status, length);
174}
175
176int tox_set_userstatus(void *tox, USERSTATUS status)
177{
178 Messenger *m = tox;
179 return m_set_userstatus(m, status);
180}
181
182/* return the length of friendnumber's status message,
183 including null
184 pass it into malloc */
185int tox_get_statusmessage_size(void *tox, int friendnumber)
186{
187 Messenger *m = tox;
188 return m_get_statusmessage_size(m, friendnumber);
189}
190
191/* copy friendnumber's status message into buf, truncating if size is over maxlen
192 get the size you need to allocate from m_get_statusmessage_size
193 The self variant will copy our own status message. */
194int tox_copy_statusmessage(void *tox, int friendnumber, uint8_t *buf, uint32_t maxlen)
195{
196 Messenger *m = tox;
197 return m_copy_statusmessage(m, friendnumber, buf, maxlen);
198}
199
200int tox_copy_self_statusmessage(void *tox, uint8_t *buf, uint32_t maxlen)
201{
202 Messenger *m = tox;
203 return m_copy_self_statusmessage(m, buf, maxlen);
204}
205
206/* Return one of USERSTATUS values.
207 * Values unknown to your application should be represented as USERSTATUS_NONE.
208 * As above, the self variant will return our own USERSTATUS.
209 * If friendnumber is invalid, this shall return USERSTATUS_INVALID. */
210USERSTATUS tox_get_userstatus(void *tox, int friendnumber)
211{
212 Messenger *m = tox;
213 return m_get_userstatus(m, friendnumber);
214}
215
216USERSTATUS tox_get_selfuserstatus(void *tox)
217{
218 Messenger *m = tox;
219 return m_get_self_userstatus(m);
220}
221
222
223/* Sets whether we send read receipts for friendnumber.
224 * This function is not lazy, and it will fail if yesno is not (0 or 1).*/
225void tox_set_sends_receipts(void *tox, int friendnumber, int yesno)
226{
227 Messenger *m = tox;
228 m_set_sends_receipts(m, friendnumber, yesno);
229}
230
231
232/* set the function that will be executed when a friend request is received.
233 function format is function(uint8_t * public_key, uint8_t * data, uint16_t length) */
234void tox_callback_friendrequest(void *tox, void (*function)(uint8_t *, uint8_t *, uint16_t, void *), void *userdata)
235{
236 Messenger *m = tox;
237 m_callback_friendrequest(m, function, userdata);
238}
239
240
241/* set the function that will be executed when a message from a friend is received.
242 function format is: function(int friendnumber, uint8_t * message, uint32_t length) */
243void tox_callback_friendmessage(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
244 void *userdata)
245{
246 Messenger *m = tox;
247 m_callback_friendmessage(m, function, userdata);
248}
249
250/* set the function that will be executed when an action from a friend is received.
251 function format is: function(int friendnumber, uint8_t * action, uint32_t length) */
252void tox_callback_action(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *), void *userdata)
253{
254 Messenger *m = tox;
255 m_callback_action(m, function, userdata);
256}
257
258/* set the callback for name changes
259 function(int friendnumber, uint8_t *newname, uint16_t length)
260 you are not responsible for freeing newname */
261void tox_callback_namechange(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
262 void *userdata)
263{
264 Messenger *m = tox;
265 m_callback_namechange(m, function, userdata);
266}
267
268/* set the callback for status message changes
269 function(int friendnumber, uint8_t *newstatus, uint16_t length)
270 you are not responsible for freeing newstatus */
271void tox_callback_statusmessage(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
272 void *userdata)
273{
274 Messenger *m = tox;
275 m_callback_statusmessage(m, function, userdata);
276}
277
278/* set the callback for status type changes
279 function(int friendnumber, USERSTATUS kind) */
280void tox_callback_userstatus(void *tox, void (*function)(Messenger *tox, int, USERSTATUS, void *), void *userdata)
281{
282 Messenger *m = tox;
283 m_callback_userstatus(m, function, userdata);
284}
285
286/* set the callback for read receipts
287 function(int friendnumber, uint32_t receipt)
288 if you are keeping a record of returns from m_sendmessage,
289 receipt might be one of those values, and that means the message
290 has been received on the other side. since core doesn't
291 track ids for you, receipt may not correspond to any message
292 in that case, you should discard it. */
293void tox_callback_read_receipt(void *tox, void (*function)(Messenger *tox, int, uint32_t, void *), void *userdata)
294{
295 Messenger *m = tox;
296 m_callback_read_receipt(m, function, userdata);
297}
298
299/* set the callback for connection status changes
300 function(int friendnumber, uint8_t status)
301 status:
302 0 -- friend went offline after being previously online
303 1 -- friend went online
304 note that this callback is not called when adding friends, thus the "after
305 being previously online" part. it's assumed that when adding friends,
306 their connection status is offline. */
307void tox_callback_connectionstatus(void *tox, void (*function)(Messenger *tox, int, uint8_t, void *), void *userdata)
308{
309 Messenger *m = tox;
310 m_callback_connectionstatus(m, function, userdata);
311}
312
313/* Use this function to bootstrap the client
314 Sends a get nodes request to the given node with ip port and public_key */
315void tox_bootstrap(void *tox, IP_Port ip_port, uint8_t *public_key)
316{
317 Messenger *m = tox;
318 DHT_bootstrap(m->dht, ip_port, public_key);
319}
320
321/* returns 0 if we are not connected to the DHT
322 returns 1 if we are */
323int tox_isconnected(void *tox)
324{
325 Messenger *m = tox;
326 return DHT_isconnected(m->dht);
327}
328
329/* run this at startup
330 * returns allocated instance of tox on success
331 * returns 0 if there are problems */
332void *tox_new(void)
333{
334 return initMessenger();
335}
336
337/* run this before closing shop
338 * free all datastructures */
339void tox_kill(void *tox)
340{
341 Messenger *m = tox;
342 cleanupMessenger(m);
343}
344
345/* the main loop that needs to be run at least 20 times per second */
346void tox_do(void *tox)
347{
348 Messenger *m = tox;
349 doMessenger(m);
350}
351
352/* SAVING AND LOADING FUNCTIONS: */
353
354/* returns the size of the messenger data (for saving) */
355uint32_t tox_size(void *tox)
356{
357 Messenger *m = tox;
358 return Messenger_size(m);
359}
360
361/* save the messenger in data (must be allocated memory of size Messenger_size()) */
362void tox_save(void *tox, uint8_t *data)
363{
364 Messenger *m = tox;
365 Messenger_save(m, data);
366}
367
368/* load the messenger from data of size length */
369int tox_load(void *tox, uint8_t *data, uint32_t length)
370{
371 Messenger *m = tox;
372 return Messenger_load(m, data, length);
373}
374
diff --git a/core/tox.h b/core/tox.h
new file mode 100644
index 00000000..bdfac1d6
--- /dev/null
+++ b/core/tox.h
@@ -0,0 +1,289 @@
1/* tox.h
2 *
3 * The Tox public API.
4 *
5 * Copyright (C) 2013 Tox project All Rights Reserved.
6 *
7 * This file is part of Tox.
8 *
9 * Tox is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * Tox is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with Tox. If not, see <http://www.gnu.org/licenses/>.
21 *
22 */
23
24#ifndef TOX_H
25#define TOX_H
26
27#include <stdint.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#define TOX_MAX_NAME_LENGTH 128
34#define TOX_MAX_STATUSMESSAGE_LENGTH 128
35#define TOX_CLIENT_ID_SIZE 32
36
37#define TOX_FRIEND_ADDRESS_SIZE (TOX_CLIENT_ID_SIZE + sizeof(uint32_t) + sizeof(uint16_t))
38
39
40typedef union {
41 uint8_t c[4];
42 uint16_t s[2];
43 uint32_t i;
44} tox_IP;
45
46typedef struct {
47 tox_IP ip;
48 uint16_t port;
49 /* not used for anything right now */
50 uint16_t padding;
51} tox_IP_Port;
52
53/* status definitions */
54enum {
55 TOX_NOFRIEND,
56 TOX_FRIEND_ADDED,
57 TOX_FRIEND_REQUESTED,
58 TOX_FRIEND_CONFIRMED,
59 TOX_FRIEND_ONLINE,
60};
61
62/* errors for m_addfriend
63 * FAERR - Friend Add Error */
64enum {
65 TOX_FAERR_TOOLONG = -1,
66 TOX_FAERR_NOMESSAGE = -2,
67 TOX_FAERR_OWNKEY = -3,
68 TOX_FAERR_ALREADYSENT = -4,
69 TOX_FAERR_UNKNOWN = -5,
70 TOX_FAERR_BADCHECKSUM = -6,
71 TOX_FAERR_SETNEWNOSPAM = -7,
72 TOX_FAERR_NOMEM = -8
73};
74/* USERSTATUS
75 * Represents userstatuses someone can have. */
76
77typedef enum {
78 TOX_USERSTATUS_NONE,
79 TOX_USERSTATUS_AWAY,
80 TOX_USERSTATUS_BUSY,
81 TOX_USERSTATUS_INVALID
82}
83TOX_USERSTATUS;
84
85typedef void Tox;
86
87/*
88 * returns a FRIEND_ADDRESS_SIZE byte address to give to others.
89 * format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
90 *
91 */
92void tox_getaddress(Tox *tox, uint8_t *address);
93
94/*
95 * add a friend
96 * set the data that will be sent along with friend request
97 * address is the address of the friend (returned by getaddress of the friend you wish to add) it must be FRIEND_ADDRESS_SIZE bytes. TODO: add checksum.
98 * data is the data and length is the length
99 * returns the friend number if success
100 * return TOX_FA_TOOLONG if message length is too long
101 * return TOX_FAERR_NOMESSAGE if no message (message length must be >= 1 byte)
102 * return TOX_FAERR_OWNKEY if user's own key
103 * return TOX_FAERR_ALREADYSENT if friend request already sent or already a friend
104 * return TOX_FAERR_UNKNOWN for unknown error
105 * return TOX_FAERR_BADCHECKSUM if bad checksum in address
106 * return TOX_FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different
107 * (the nospam for that friend was set to the new one)
108 * return TOX_FAERR_NOMEM if increasing the friend list size fails
109 */
110int tox_addfriend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length);
111
112
113/* add a friend without sending a friendrequest.
114 returns the friend number if success
115 return -1 if failure. */
116int tox_addfriend_norequest(Tox *tox, uint8_t *client_id);
117
118/* return the friend id associated to that client id.
119 return -1 if no such friend */
120int tox_getfriend_id(Tox *tox, uint8_t *client_id);
121
122/* copies the public key associated to that friend id into client_id buffer.
123 make sure that client_id is of size CLIENT_ID_SIZE.
124 return 0 if success
125 return -1 if failure */
126int tox_getclient_id(Tox *tox, int friend_id, uint8_t *client_id);
127
128/* remove a friend */
129int tox_delfriend(Tox *tox, int friendnumber);
130
131/* return TOX_FRIEND_ONLINE if friend is online
132 return TOX_FRIEND_CONFIRMED if friend is confirmed
133 return TOX_FRIEND_REQUESTED if the friend request was sent
134 return TOX_FRIEND_ADDED if the friend was added
135 return TOX_NOFRIEND if there is no friend with that number */
136int tox_friendstatus(Tox *tox, int friendnumber);
137
138/* send a text chat message to an online friend
139 returns the message id if packet was successfully put into the send queue
140 return 0 if it was not
141 you will want to retain the return value, it will be passed to your read receipt callback
142 if one is received.
143 m_sendmessage_withid will send a message with the id of your choosing,
144 however we can generate an id for you by calling plain m_sendmessage. */
145uint32_t tox_sendmessage(Tox *tox, int friendnumber, uint8_t *message, uint32_t length);
146uint32_t tox_sendmessage_withid(Tox *tox, int friendnumber, uint32_t theid, uint8_t *message, uint32_t length);
147
148/* send an action to an online friend
149 returns 1 if packet was successfully put into the send queue
150 return 0 if it was not */
151int tox_sendaction(Tox *tox, int friendnumber, uint8_t *action, uint32_t length);
152
153/* Set our nickname
154 name must be a string of maximum MAX_NAME_LENGTH length.
155 length must be at least 1 byte
156 length is the length of name with the NULL terminator
157 return 0 if success
158 return -1 if failure */
159int tox_setname(Tox *tox, uint8_t *name, uint16_t length);
160
161/*
162 Get your nickname.
163 m The messanger context to use.
164 name Pointer to a string for the name.
165 nlen The length of the string buffer.
166 returns Return the length of the name, 0 on error.
167*/
168uint16_t tox_getselfname(Tox *tox, uint8_t *name, uint16_t nlen);
169
170/* get name of friendnumber
171 put it in name
172 name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
173 return 0 if success
174 return -1 if failure */
175int tox_getname(Tox *tox, int friendnumber, uint8_t *name);
176
177/* set our user status
178 you are responsible for freeing status after
179 returns 0 on success, -1 on failure */
180int tox_set_statusmessage(Tox *tox, uint8_t *status, uint16_t length);
181int tox_set_userstatus(Tox *tox, TOX_USERSTATUS status);
182
183/* return the length of friendnumber's status message,
184 including null
185 pass it into malloc */
186int tox_get_statusmessage_size(Tox *tox, int friendnumber);
187
188/* copy friendnumber's status message into buf, truncating if size is over maxlen
189 get the size you need to allocate from m_get_statusmessage_size
190 The self variant will copy our own status message. */
191int tox_copy_statusmessage(Tox *tox, int friendnumber, uint8_t *buf, uint32_t maxlen);
192int tox_copy_self_statusmessage(Tox *tox, uint8_t *buf, uint32_t maxlen);
193
194/* Return one of USERSTATUS values.
195 * Values unknown to your application should be represented as USERSTATUS_NONE.
196 * As above, the self variant will return our own USERSTATUS.
197 * If friendnumber is invalid, this shall return USERSTATUS_INVALID. */
198TOX_USERSTATUS tox_get_userstatus(Tox *tox, int friendnumber);
199TOX_USERSTATUS tox_get_selfuserstatus(Tox *tox);
200
201/* Sets whether we send read receipts for friendnumber.
202 * This function is not lazy, and it will fail if yesno is not (0 or 1).*/
203void tox_set_sends_receipts(Tox *tox, int friendnumber, int yesno);
204
205/* set the function that will be executed when a friend request is received.
206 function format is function(uint8_t * public_key, uint8_t * data, uint16_t length) */
207void tox_callback_friendrequest(Tox *tox, void (*function)(uint8_t *, uint8_t *, uint16_t, void *), void *userdata);
208
209/* set the function that will be executed when a message from a friend is received.
210 function format is: function(int friendnumber, uint8_t * message, uint32_t length) */
211void tox_callback_friendmessage(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
212 void *userdata);
213
214/* set the function that will be executed when an action from a friend is received.
215 function format is: function(int friendnumber, uint8_t * action, uint32_t length) */
216void tox_callback_action(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *), void *userdata);
217
218/* set the callback for name changes
219 function(int friendnumber, uint8_t *newname, uint16_t length)
220 you are not responsible for freeing newname */
221void tox_callback_namechange(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
222 void *userdata);
223
224/* set the callback for status message changes
225 function(int friendnumber, uint8_t *newstatus, uint16_t length)
226 you are not responsible for freeing newstatus */
227void tox_callback_statusmessage(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
228 void *userdata);
229
230/* set the callback for status type changes
231 function(int friendnumber, USERSTATUS kind) */
232void tox_callback_userstatus(Tox *tox, void (*function)(Tox *tox, int, TOX_USERSTATUS, void *), void *userdata);
233
234/* set the callback for read receipts
235 function(int friendnumber, uint32_t receipt)
236 if you are keeping a record of returns from m_sendmessage,
237 receipt might be one of those values, and that means the message
238 has been received on the other side. since core doesn't
239 track ids for you, receipt may not correspond to any message
240 in that case, you should discard it. */
241void tox_callback_read_receipt(Tox *tox, void (*function)(Tox *tox, int, uint32_t, void *), void *userdata);
242
243/* set the callback for connection status changes
244 function(int friendnumber, uint8_t status)
245 status:
246 0 -- friend went offline after being previously online
247 1 -- friend went online
248 note that this callback is not called when adding friends, thus the "after
249 being previously online" part. it's assumed that when adding friends,
250 their connection status is offline. */
251void tox_callback_connectionstatus(Tox *tox, void (*function)(Tox *tox, int, uint8_t, void *), void *userdata);
252
253/* Use this function to bootstrap the client
254 Sends a get nodes request to the given node with ip port and public_key */
255void tox_bootstrap(Tox *tox, tox_IP_Port ip_port, uint8_t *public_key);
256
257/* returns 0 if we are not connected to the DHT
258 returns 1 if we are */
259int tox_isconnected(Tox *tox);
260
261/* run this at startup
262 * returns allocated instance of tox on success
263 * returns 0 if there are problems */
264Tox *tox_new(void);
265
266/* run this before closing shop
267 * free all datastructures */
268void tox_kill(Tox *tox);
269
270/* the main loop that needs to be run at least 20 times per second */
271void tox_do(Tox *tox);
272
273/* SAVING AND LOADING FUNCTIONS: */
274
275/* returns the size of the messenger data (for saving) */
276uint32_t tox_size(Tox *tox);
277
278/* save the messenger in data (must be allocated memory of size Messenger_size()) */
279void tox_save(Tox *tox, uint8_t *data);
280
281/* load the messenger from data of size length */
282int tox_load(Tox *tox, uint8_t *data, uint32_t length);
283
284
285#ifdef __cplusplus
286}
287#endif
288
289#endif