Merge branch 'new-api'

New, cleaner public API added. see: core/tox.h

This does not break anything because the old API is still there.

You are however encouraged to switch to the new API.

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
         LAN_discovery.c
         Messenger.c
         util.c
-        ping.c)
+        ping.c
+        tox.c)
 
 set(core_headers
         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" {
 #define PACKET_ID_MESSAGE 64
 #define PACKET_ID_ACTION 63
 
+
 /* status definitions */
-#define FRIEND_ONLINE 4
-#define FRIEND_CONFIRMED 3
-#define FRIEND_REQUESTED 2
-#define FRIEND_ADDED 1
-#define NOFRIEND 0
+enum {
+    NOFRIEND,
+    FRIEND_ADDED,
+    FRIEND_REQUESTED,
+    FRIEND_CONFIRMED,
+    FRIEND_ONLINE,
+};
 
 /* errors for m_addfriend
  *  FAERR - Friend Add Error */
-#define FAERR_TOOLONG -1
-#define FAERR_NOMESSAGE -2
-#define FAERR_OWNKEY -3
-#define FAERR_ALREADYSENT -4
-#define FAERR_UNKNOWN -5
-#define FAERR_BADCHECKSUM -6
-#define FAERR_SETNEWNOSPAM -7
-#define FAERR_NOMEM -8
+enum {
+    FAERR_TOOLONG = -1,
+    FAERR_NOMESSAGE = -2,
+    FAERR_OWNKEY = -3,
+    FAERR_ALREADYSENT = -4,
+    FAERR_UNKNOWN = -5,
+    FAERR_BADCHECKSUM = -6,
+    FAERR_SETNEWNOSPAM = -7,
+    FAERR_NOMEM = -8
+};
 
 /* don't assume MAX_STATUSMESSAGE_LENGTH will stay at 128, it may be increased
     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)
    returns NULL if there are problems */
 Networking_Core *new_networking(IP ip, uint16_t port)
 {
-    if(at_startup() != 0)
+    if (at_startup() != 0)
         return NULL;
+
     /* initialize our socket */
     Networking_Core *temp = calloc(1, sizeof(Networking_Core));
 
@@ -215,43 +216,3 @@ void kill_networking(Networking_Core *net)
     free(net);
     return;
 }
-
-/*
-  resolve_addr():
-    address should represent IPv4 or a hostname with A record
-
-    returns a data in network byte order that can be used to set IP.i or IP_Port.ip.i
-    returns 0 on failure
-
-    TODO: Fix ipv6 support
-*/
-uint32_t resolve_addr(const char *address)
-{
-    struct addrinfo *server = NULL;
-    struct addrinfo  hints;
-    int              rc;
-    uint32_t         addr;
-
-    memset(&hints, 0, sizeof(hints));
-    hints.ai_family   = AF_INET;    // IPv4 only right now.
-    hints.ai_socktype = SOCK_DGRAM; // type of socket Tox uses.
-
-    rc = getaddrinfo(address, "echo", &hints, &server);
-
-    // Lookup failed.
-    if (rc != 0) {
-        return 0;
-    }
-
-    // IPv4 records only..
-    if (server->ai_family != AF_INET) {
-        freeaddrinfo(server);
-        return 0;
-    }
-
-
-    addr = ((struct sockaddr_in *)server->ai_addr)->sin_addr.s_addr;
-
-    freeaddrinfo(server);
-    return addr;
-}
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);
 /* function to cleanup networking stuff(doesn't do much right now) */
 void kill_networking(Networking_Core *net);
 
-/*
-  resolve_addr():
-    address should represent IPv4 or a hostname with A record
-
-    returns a data in network byte order that can be used to set IP.i or IP_Port.ip.i
-    returns 0 on failure
-
-    TODO: Fix ipv6 support
-*/
-uint32_t resolve_addr(const char *address);
 
 #ifdef __cplusplus
 }
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 @@
+/* tox.c
+ *
+ * The Tox public API.
+ *
+ *  Copyright (C) 2013 Tox project All Rights Reserved.
+ *
+ *  This file is part of Tox.
+ *
+ *  Tox is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Tox is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Tox.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "Messenger.h"
+/*
+ * returns a FRIEND_ADDRESS_SIZE byte address to give to others.
+ * format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
+ *
+ */
+void tox_getaddress(void *tox, uint8_t *address)
+{
+    Messenger *m = tox;
+    getaddress(m, address);
+}
+
+/*
+ * add a friend
+ * set the data that will be sent along with friend request
+ * 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.
+ * data is the data and length is the length
+ * returns the friend number if success
+ * return FA_TOOLONG if message length is too long
+ * return FAERR_NOMESSAGE if no message (message length must be >= 1 byte)
+ * return FAERR_OWNKEY if user's own key
+ * return FAERR_ALREADYSENT if friend request already sent or already a friend
+ * return FAERR_UNKNOWN for unknown error
+ * return FAERR_BADCHECKSUM if bad checksum in address
+ * return FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different
+ * (the nospam for that friend was set to the new one)
+ * return FAERR_NOMEM if increasing the friend list size fails
+ */
+int tox_addfriend(void *tox, uint8_t *address, uint8_t *data, uint16_t length)
+{
+    Messenger *m = tox;
+    return m_addfriend(m, address, data, length);
+}
+
+/* add a friend without sending a friendrequest.
+    returns the friend number if success
+    return -1 if failure. */
+int tox_addfriend_norequest(void *tox, uint8_t *client_id)
+{
+    Messenger *m = tox;
+    return m_addfriend_norequest(m, client_id);
+}
+
+/* return the friend id associated to that client id.
+    return -1 if no such friend */
+int tox_getfriend_id(void *tox, uint8_t *client_id)
+{
+    Messenger *m = tox;
+    return getfriend_id(m, client_id);
+}
+
+/* copies the public key associated to that friend id into client_id buffer.
+    make sure that client_id is of size CLIENT_ID_SIZE.
+    return 0 if success
+    return -1 if failure */
+int tox_getclient_id(void *tox, int friend_id, uint8_t *client_id)
+{
+    Messenger *m = tox;
+    return getclient_id(m, friend_id, client_id);
+}
+
+/* remove a friend */
+int tox_delfriend(void *tox, int friendnumber)
+{
+    Messenger *m = tox;
+    return m_delfriend(m, friendnumber);
+}
+
+/* return 4 if friend is online
+    return 3 if friend is confirmed
+    return 2 if the friend request was sent
+    return 1 if the friend was added
+    return 0 if there is no friend with that number */
+int tox_friendstatus(void *tox, int friendnumber)
+{
+    Messenger *m = tox;
+    return m_friendstatus(m, friendnumber);
+}
+
+/* send a text chat message to an online friend
+    returns the message id if packet was successfully put into the send queue
+    return 0 if it was not
+    you will want to retain the return value, it will be passed to your read receipt callback
+    if one is received.
+    m_sendmessage_withid will send a message with the id of your choosing,
+    however we can generate an id for you by calling plain m_sendmessage. */
+uint32_t tox_sendmessage(void *tox, int friendnumber, uint8_t *message, uint32_t length)
+{
+    Messenger *m = tox;
+    return m_sendmessage(m, friendnumber, message, length);
+}
+
+uint32_t tox_sendmessage_withid(void *tox, int friendnumber, uint32_t theid, uint8_t *message, uint32_t length)
+{
+    Messenger *m = tox;
+    return m_sendmessage_withid(m, friendnumber, theid, message, length);
+}
+
+/* send an action to an online friend
+    returns 1 if packet was successfully put into the send queue
+    return 0 if it was not */
+int tox_sendaction(void *tox, int friendnumber, uint8_t *action, uint32_t length)
+{
+    Messenger *m = tox;
+    return m_sendaction(m, friendnumber, action, length);
+}
+
+/* Set our nickname
+   name must be a string of maximum MAX_NAME_LENGTH length.
+   length must be at least 1 byte
+   length is the length of name with the NULL terminator
+   return 0 if success
+   return -1 if failure */
+int tox_setname(void *tox, uint8_t *name, uint16_t length)
+{
+    Messenger *m = tox;
+    return setname(m, name, length);
+}
+
+/*
+   Get your nickname.
+   m        The messanger context to use.
+   name    Pointer to a string for the name.
+   nlen     The length of the string buffer.
+   returns Return the length of the name, 0 on error.
+*/
+uint16_t tox_getselfname(void *tox, uint8_t *name, uint16_t nlen)
+{
+    Messenger *m = tox;
+    return getself_name(m, name, nlen);
+}
+
+/* get name of friendnumber
+    put it in name
+    name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
+    return 0 if success
+    return -1 if failure */
+int tox_getname(void *tox, int friendnumber, uint8_t *name)
+{
+    Messenger *m = tox;
+    return getname(m, friendnumber, name);
+}
+
+/* set our user status
+    you are responsible for freeing status after
+    returns 0 on success, -1 on failure */
+int tox_set_statusmessage(void *tox, uint8_t *status, uint16_t length)
+{
+    Messenger *m = tox;
+    return m_set_statusmessage(m, status, length);
+}
+
+int tox_set_userstatus(void *tox, USERSTATUS status)
+{
+    Messenger *m = tox;
+    return m_set_userstatus(m, status);
+}
+
+/* return the length of friendnumber's status message,
+    including null
+    pass it into malloc */
+int tox_get_statusmessage_size(void *tox, int friendnumber)
+{
+    Messenger *m = tox;
+    return m_get_statusmessage_size(m, friendnumber);
+}
+
+/* copy friendnumber's status message into buf, truncating if size is over maxlen
+    get the size you need to allocate from m_get_statusmessage_size
+    The self variant will copy our own status message. */
+int tox_copy_statusmessage(void *tox, int friendnumber, uint8_t *buf, uint32_t maxlen)
+{
+    Messenger *m = tox;
+    return m_copy_statusmessage(m, friendnumber, buf, maxlen);
+}
+
+int tox_copy_self_statusmessage(void *tox, uint8_t *buf, uint32_t maxlen)
+{
+    Messenger *m = tox;
+    return m_copy_self_statusmessage(m, buf, maxlen);
+}
+
+/* Return one of USERSTATUS values.
+ * Values unknown to your application should be represented as USERSTATUS_NONE.
+ * As above, the self variant will return our own USERSTATUS.
+ * If friendnumber is invalid, this shall return USERSTATUS_INVALID. */
+USERSTATUS tox_get_userstatus(void *tox, int friendnumber)
+{
+    Messenger *m = tox;
+    return m_get_userstatus(m, friendnumber);
+}
+
+USERSTATUS tox_get_selfuserstatus(void *tox)
+{
+    Messenger *m = tox;
+    return m_get_self_userstatus(m);
+}
+
+
+/* Sets whether we send read receipts for friendnumber.
+ * This function is not lazy, and it will fail if yesno is not (0 or 1).*/
+void tox_set_sends_receipts(void *tox, int friendnumber, int yesno)
+{
+    Messenger *m = tox;
+    m_set_sends_receipts(m, friendnumber, yesno);
+}
+
+
+/* set the function that will be executed when a friend request is received.
+    function format is function(uint8_t * public_key, uint8_t * data, uint16_t length) */
+void tox_callback_friendrequest(void *tox, void (*function)(uint8_t *, uint8_t *, uint16_t, void *), void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_friendrequest(m, function, userdata);
+}
+
+
+/* set the function that will be executed when a message from a friend is received.
+    function format is: function(int friendnumber, uint8_t * message, uint32_t length) */
+void tox_callback_friendmessage(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
+                                void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_friendmessage(m, function, userdata);
+}
+
+/* set the function that will be executed when an action from a friend is received.
+    function format is: function(int friendnumber, uint8_t * action, uint32_t length) */
+void tox_callback_action(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *), void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_action(m, function, userdata);
+}
+
+/* set the callback for name changes
+    function(int friendnumber, uint8_t *newname, uint16_t length)
+    you are not responsible for freeing newname */
+void tox_callback_namechange(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
+                             void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_namechange(m, function, userdata);
+}
+
+/* set the callback for status message changes
+    function(int friendnumber, uint8_t *newstatus, uint16_t length)
+    you are not responsible for freeing newstatus */
+void tox_callback_statusmessage(void *tox, void (*function)(Messenger *tox, int, uint8_t *, uint16_t, void *),
+                                void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_statusmessage(m, function, userdata);
+}
+
+/* set the callback for status type changes
+    function(int friendnumber, USERSTATUS kind) */
+void tox_callback_userstatus(void *tox, void (*function)(Messenger *tox, int, USERSTATUS, void *), void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_userstatus(m, function, userdata);
+}
+
+/* set the callback for read receipts
+    function(int friendnumber, uint32_t receipt)
+    if you are keeping a record of returns from m_sendmessage,
+    receipt might be one of those values, and that means the message
+    has been received on the other side. since core doesn't
+    track ids for you, receipt may not correspond to any message
+    in that case, you should discard it. */
+void tox_callback_read_receipt(void *tox, void (*function)(Messenger *tox, int, uint32_t, void *), void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_read_receipt(m, function, userdata);
+}
+
+/* set the callback for connection status changes
+    function(int friendnumber, uint8_t status)
+    status:
+      0 -- friend went offline after being previously online
+      1 -- friend went online
+    note that this callback is not called when adding friends, thus the "after
+    being previously online" part. it's assumed that when adding friends,
+    their connection status is offline. */
+void tox_callback_connectionstatus(void *tox, void (*function)(Messenger *tox, int, uint8_t, void *), void *userdata)
+{
+    Messenger *m = tox;
+    m_callback_connectionstatus(m, function, userdata);
+}
+
+/* Use this function to bootstrap the client
+    Sends a get nodes request to the given node with ip port and public_key */
+void tox_bootstrap(void *tox, IP_Port ip_port, uint8_t *public_key)
+{
+    Messenger *m = tox;
+    DHT_bootstrap(m->dht, ip_port, public_key);
+}
+
+/* returns 0 if we are not connected to the DHT
+    returns 1 if we are */
+int tox_isconnected(void *tox)
+{
+    Messenger *m = tox;
+    return DHT_isconnected(m->dht);
+}
+
+/* run this at startup
+ *  returns allocated instance of tox on success
+ *  returns 0 if there are problems */
+void *tox_new(void)
+{
+    return initMessenger();
+}
+
+/* run this before closing shop
+ * free all datastructures */
+void tox_kill(void *tox)
+{
+    Messenger *m = tox;
+    cleanupMessenger(m);
+}
+
+/* the main loop that needs to be run at least 20 times per second */
+void tox_do(void *tox)
+{
+    Messenger *m = tox;
+    doMessenger(m);
+}
+
+/* SAVING AND LOADING FUNCTIONS: */
+
+/* returns the size of the messenger data (for saving) */
+uint32_t tox_size(void *tox)
+{
+    Messenger *m = tox;
+    return Messenger_size(m);
+}
+
+/* save the messenger in data (must be allocated memory of size Messenger_size()) */
+void tox_save(void *tox, uint8_t *data)
+{
+    Messenger *m = tox;
+    Messenger_save(m, data);
+}
+
+/* load the messenger from data of size length */
+int tox_load(void *tox, uint8_t *data, uint32_t length)
+{
+    Messenger *m = tox;
+    return Messenger_load(m, data, length);
+}
+
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 @@
+/* tox.h
+ *
+ * The Tox public API.
+ *
+ *  Copyright (C) 2013 Tox project All Rights Reserved.
+ *
+ *  This file is part of Tox.
+ *
+ *  Tox is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Tox is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Tox.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef TOX_H
+#define TOX_H
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define TOX_MAX_NAME_LENGTH 128
+#define TOX_MAX_STATUSMESSAGE_LENGTH 128
+#define TOX_CLIENT_ID_SIZE 32
+
+#define TOX_FRIEND_ADDRESS_SIZE (TOX_CLIENT_ID_SIZE + sizeof(uint32_t) + sizeof(uint16_t))
+
+
+typedef union {
+    uint8_t c[4];
+    uint16_t s[2];
+    uint32_t i;
+} tox_IP;
+
+typedef struct {
+    tox_IP ip;
+    uint16_t port;
+    /* not used for anything right now */
+    uint16_t padding;
+} tox_IP_Port;
+
+/* status definitions */
+enum {
+    TOX_NOFRIEND,
+    TOX_FRIEND_ADDED,
+    TOX_FRIEND_REQUESTED,
+    TOX_FRIEND_CONFIRMED,
+    TOX_FRIEND_ONLINE,
+};
+
+/* errors for m_addfriend
+ *  FAERR - Friend Add Error */
+enum {
+    TOX_FAERR_TOOLONG = -1,
+    TOX_FAERR_NOMESSAGE = -2,
+    TOX_FAERR_OWNKEY = -3,
+    TOX_FAERR_ALREADYSENT = -4,
+    TOX_FAERR_UNKNOWN = -5,
+    TOX_FAERR_BADCHECKSUM = -6,
+    TOX_FAERR_SETNEWNOSPAM = -7,
+    TOX_FAERR_NOMEM = -8
+};
+/* USERSTATUS
+ * Represents userstatuses someone can have. */
+
+typedef enum {
+    TOX_USERSTATUS_NONE,
+    TOX_USERSTATUS_AWAY,
+    TOX_USERSTATUS_BUSY,
+    TOX_USERSTATUS_INVALID
+}
+TOX_USERSTATUS;
+
+typedef void Tox;
+
+/*
+ * returns a FRIEND_ADDRESS_SIZE byte address to give to others.
+ * format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
+ *
+ */
+void tox_getaddress(Tox *tox, uint8_t *address);
+
+/*
+ * add a friend
+ * set the data that will be sent along with friend request
+ * 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.
+ * data is the data and length is the length
+ * returns the friend number if success
+ * return TOX_FA_TOOLONG if message length is too long
+ * return TOX_FAERR_NOMESSAGE if no message (message length must be >= 1 byte)
+ * return TOX_FAERR_OWNKEY if user's own key
+ * return TOX_FAERR_ALREADYSENT if friend request already sent or already a friend
+ * return TOX_FAERR_UNKNOWN for unknown error
+ * return TOX_FAERR_BADCHECKSUM if bad checksum in address
+ * return TOX_FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different
+ * (the nospam for that friend was set to the new one)
+ * return TOX_FAERR_NOMEM if increasing the friend list size fails
+ */
+int tox_addfriend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length);
+
+
+/* add a friend without sending a friendrequest.
+    returns the friend number if success
+    return -1 if failure. */
+int tox_addfriend_norequest(Tox *tox, uint8_t *client_id);
+
+/* return the friend id associated to that client id.
+    return -1 if no such friend */
+int tox_getfriend_id(Tox *tox, uint8_t *client_id);
+
+/* copies the public key associated to that friend id into client_id buffer.
+    make sure that client_id is of size CLIENT_ID_SIZE.
+    return 0 if success
+    return -1 if failure */
+int tox_getclient_id(Tox *tox, int friend_id, uint8_t *client_id);
+
+/* remove a friend */
+int tox_delfriend(Tox *tox, int friendnumber);
+
+/*  return TOX_FRIEND_ONLINE if friend is online
+    return TOX_FRIEND_CONFIRMED if friend is confirmed
+    return TOX_FRIEND_REQUESTED if the friend request was sent
+    return TOX_FRIEND_ADDED if the friend was added
+    return TOX_NOFRIEND if there is no friend with that number */
+int tox_friendstatus(Tox *tox, int friendnumber);
+
+/* send a text chat message to an online friend
+    returns the message id if packet was successfully put into the send queue
+    return 0 if it was not
+    you will want to retain the return value, it will be passed to your read receipt callback
+    if one is received.
+    m_sendmessage_withid will send a message with the id of your choosing,
+    however we can generate an id for you by calling plain m_sendmessage. */
+uint32_t tox_sendmessage(Tox *tox, int friendnumber, uint8_t *message, uint32_t length);
+uint32_t tox_sendmessage_withid(Tox *tox, int friendnumber, uint32_t theid, uint8_t *message, uint32_t length);
+
+/* send an action to an online friend
+    returns 1 if packet was successfully put into the send queue
+    return 0 if it was not */
+int tox_sendaction(Tox *tox, int friendnumber, uint8_t *action, uint32_t length);
+
+/* Set our nickname
+   name must be a string of maximum MAX_NAME_LENGTH length.
+   length must be at least 1 byte
+   length is the length of name with the NULL terminator
+   return 0 if success
+   return -1 if failure */
+int tox_setname(Tox *tox, uint8_t *name, uint16_t length);
+
+/*
+   Get your nickname.
+   m        The messanger context to use.
+   name    Pointer to a string for the name.
+   nlen     The length of the string buffer.
+   returns Return the length of the name, 0 on error.
+*/
+uint16_t tox_getselfname(Tox *tox, uint8_t *name, uint16_t nlen);
+
+/* get name of friendnumber
+    put it in name
+    name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
+    return 0 if success
+    return -1 if failure */
+int tox_getname(Tox *tox, int friendnumber, uint8_t *name);
+
+/* set our user status
+    you are responsible for freeing status after
+    returns 0 on success, -1 on failure */
+int tox_set_statusmessage(Tox *tox, uint8_t *status, uint16_t length);
+int tox_set_userstatus(Tox *tox, TOX_USERSTATUS status);
+
+/* return the length of friendnumber's status message,
+    including null
+    pass it into malloc */
+int tox_get_statusmessage_size(Tox *tox, int friendnumber);
+
+/* copy friendnumber's status message into buf, truncating if size is over maxlen
+    get the size you need to allocate from m_get_statusmessage_size
+    The self variant will copy our own status message. */
+int tox_copy_statusmessage(Tox *tox, int friendnumber, uint8_t *buf, uint32_t maxlen);
+int tox_copy_self_statusmessage(Tox *tox, uint8_t *buf, uint32_t maxlen);
+
+/* Return one of USERSTATUS values.
+ * Values unknown to your application should be represented as USERSTATUS_NONE.
+ * As above, the self variant will return our own USERSTATUS.
+ * If friendnumber is invalid, this shall return USERSTATUS_INVALID. */
+TOX_USERSTATUS tox_get_userstatus(Tox *tox, int friendnumber);
+TOX_USERSTATUS tox_get_selfuserstatus(Tox *tox);
+
+/* Sets whether we send read receipts for friendnumber.
+ * This function is not lazy, and it will fail if yesno is not (0 or 1).*/
+void tox_set_sends_receipts(Tox *tox, int friendnumber, int yesno);
+
+/* set the function that will be executed when a friend request is received.
+    function format is function(uint8_t * public_key, uint8_t * data, uint16_t length) */
+void tox_callback_friendrequest(Tox *tox, void (*function)(uint8_t *, uint8_t *, uint16_t, void *), void *userdata);
+
+/* set the function that will be executed when a message from a friend is received.
+    function format is: function(int friendnumber, uint8_t * message, uint32_t length) */
+void tox_callback_friendmessage(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
+                                void *userdata);
+
+/* set the function that will be executed when an action from a friend is received.
+    function format is: function(int friendnumber, uint8_t * action, uint32_t length) */
+void tox_callback_action(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *), void *userdata);
+
+/* set the callback for name changes
+    function(int friendnumber, uint8_t *newname, uint16_t length)
+    you are not responsible for freeing newname */
+void tox_callback_namechange(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
+                             void *userdata);
+
+/* set the callback for status message changes
+    function(int friendnumber, uint8_t *newstatus, uint16_t length)
+    you are not responsible for freeing newstatus */
+void tox_callback_statusmessage(Tox *tox, void (*function)(Tox *tox, int, uint8_t *, uint16_t, void *),
+                                void *userdata);
+
+/* set the callback for status type changes
+    function(int friendnumber, USERSTATUS kind) */
+void tox_callback_userstatus(Tox *tox, void (*function)(Tox *tox, int, TOX_USERSTATUS, void *), void *userdata);
+
+/* set the callback for read receipts
+    function(int friendnumber, uint32_t receipt)
+    if you are keeping a record of returns from m_sendmessage,
+    receipt might be one of those values, and that means the message
+    has been received on the other side. since core doesn't
+    track ids for you, receipt may not correspond to any message
+    in that case, you should discard it. */
+void tox_callback_read_receipt(Tox *tox, void (*function)(Tox *tox, int, uint32_t, void *), void *userdata);
+
+/* set the callback for connection status changes
+    function(int friendnumber, uint8_t status)
+    status:
+      0 -- friend went offline after being previously online
+      1 -- friend went online
+    note that this callback is not called when adding friends, thus the "after
+    being previously online" part. it's assumed that when adding friends,
+    their connection status is offline. */
+void tox_callback_connectionstatus(Tox *tox, void (*function)(Tox *tox, int, uint8_t, void *), void *userdata);
+
+/* Use this function to bootstrap the client
+    Sends a get nodes request to the given node with ip port and public_key */
+void tox_bootstrap(Tox *tox, tox_IP_Port ip_port, uint8_t *public_key);
+
+/* returns 0 if we are not connected to the DHT
+    returns 1 if we are */
+int tox_isconnected(Tox *tox);
+
+/* run this at startup
+ *  returns allocated instance of tox on success
+ *  returns 0 if there are problems */
+Tox *tox_new(void);
+
+/* run this before closing shop
+ * free all datastructures */
+void tox_kill(Tox *tox);
+
+/* the main loop that needs to be run at least 20 times per second */
+void tox_do(Tox *tox);
+
+/* SAVING AND LOADING FUNCTIONS: */
+
+/* returns the size of the messenger data (for saving) */
+uint32_t tox_size(Tox *tox);
+
+/* save the messenger in data (must be allocated memory of size Messenger_size()) */
+void tox_save(Tox *tox, uint8_t *data);
+
+/* load the messenger from data of size length */
+int tox_load(Tox *tox, uint8_t *data, uint32_t length);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif