summaryrefslogtreecommitdiff
path: root/libs/libtox/src/toxcore/group.h
diff options
context:
space:
mode:
authoraunsane <aunsane@gmail.com>2017-12-20 23:44:35 +0300
committeraunsane <aunsane@gmail.com>2017-12-20 23:46:11 +0300
commite6cb2c87dc119268a75ac6f41645b96400abdd7c (patch)
treef97e4ba7da8715358f13b7189769597bf6d2e75e /libs/libtox/src/toxcore/group.h
parentc8548c468436fc3a2fccc00be9f48e6b7f0a1df2 (diff)
libtox moved to tox folder instead of libs
Diffstat (limited to 'libs/libtox/src/toxcore/group.h')
-rw-r--r--libs/libtox/src/toxcore/group.h395
1 files changed, 0 insertions, 395 deletions
diff --git a/libs/libtox/src/toxcore/group.h b/libs/libtox/src/toxcore/group.h
deleted file mode 100644
index 2e014da36d..0000000000
--- a/libs/libtox/src/toxcore/group.h
+++ /dev/null
@@ -1,395 +0,0 @@
-/*
- * Slightly better groupchats implementation.
- */
-
-/*
- * Copyright © 2016-2017 The TokTok team.
- * Copyright © 2014 Tox project.
- *
- * This file is part of Tox, the free peer to peer instant messenger.
- *
- * 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 GROUP_H
-#define GROUP_H
-
-#include "Messenger.h"
-
-enum {
- GROUPCHAT_STATUS_NONE,
- GROUPCHAT_STATUS_VALID,
- GROUPCHAT_STATUS_CONNECTED
-};
-
-enum {
- GROUPCHAT_TYPE_TEXT,
- GROUPCHAT_TYPE_AV
-};
-
-#define MAX_LOSSY_COUNT 256
-
-typedef struct {
- uint8_t real_pk[CRYPTO_PUBLIC_KEY_SIZE];
- uint8_t temp_pk[CRYPTO_PUBLIC_KEY_SIZE];
-
- uint64_t last_recv;
- uint32_t last_message_number;
-
- uint8_t nick[MAX_NAME_LENGTH];
- uint8_t nick_len;
-
- uint16_t peer_number;
-
- uint8_t recv_lossy[MAX_LOSSY_COUNT];
- uint16_t bottom_lossy_number, top_lossy_number;
-
- void *object;
-} Group_Peer;
-
-#define DESIRED_CLOSE_CONNECTIONS 4
-#define MAX_GROUP_CONNECTIONS 16
-#define GROUP_IDENTIFIER_LENGTH (1 + CRYPTO_SYMMETRIC_KEY_SIZE) /* type + CRYPTO_SYMMETRIC_KEY_SIZE so we can use new_symmetric_key(...) to fill it */
-
-enum {
- GROUPCHAT_CLOSE_NONE,
- GROUPCHAT_CLOSE_CONNECTION,
- GROUPCHAT_CLOSE_ONLINE
-};
-
-typedef struct {
- uint8_t status;
-
- Group_Peer *group;
- uint32_t numpeers;
-
- struct {
- uint8_t type; /* GROUPCHAT_CLOSE_* */
- uint8_t closest;
- uint32_t number;
- uint16_t group_number;
- } close[MAX_GROUP_CONNECTIONS];
-
- uint8_t real_pk[CRYPTO_PUBLIC_KEY_SIZE];
- struct {
- uint8_t entry;
- uint8_t real_pk[CRYPTO_PUBLIC_KEY_SIZE];
- uint8_t temp_pk[CRYPTO_PUBLIC_KEY_SIZE];
- } closest_peers[DESIRED_CLOSE_CONNECTIONS];
- uint8_t changed;
-
- uint8_t identifier[GROUP_IDENTIFIER_LENGTH];
-
- uint8_t title[MAX_NAME_LENGTH];
- uint8_t title_len;
-
- uint32_t message_number;
- uint16_t lossy_message_number;
- uint16_t peer_number;
-
- uint64_t last_sent_ping;
-
- int number_joined; /* friendcon_id of person that invited us to the chat. (-1 means none) */
-
- void *object;
-
- void (*peer_on_join)(void *, int, int);
- void (*peer_on_leave)(void *, int, int, void *);
- void (*group_on_delete)(void *, int);
-} Group_c;
-
-typedef struct {
- Messenger *m;
- Friend_Connections *fr_c;
-
- Group_c *chats;
- uint32_t num_chats;
-
- void (*invite_callback)(Messenger *m, uint32_t, int, const uint8_t *, size_t, void *);
- void (*message_callback)(Messenger *m, uint32_t, uint32_t, int, const uint8_t *, size_t, void *);
- void (*group_namelistchange)(Messenger *m, int, int, uint8_t, void *);
- void (*title_callback)(Messenger *m, uint32_t, uint32_t, const uint8_t *, size_t, void *);
-
- struct {
- int (*function)(void *, int, int, void *, const uint8_t *, uint16_t);
- } lossy_packethandlers[256];
-} Group_Chats;
-
-/* Set the callback for group invites.
- *
- * Function(Group_Chats *g_c, int32_t friendnumber, uint8_t type, uint8_t *data, uint16_t length, void *userdata)
- *
- * data of length is what needs to be passed to join_groupchat().
- */
-void g_callback_group_invite(Group_Chats *g_c, void (*function)(Messenger *m, uint32_t, int, const uint8_t *,
- size_t, void *));
-
-/* Set the callback for group messages.
- *
- * Function(Group_Chats *g_c, int groupnumber, int friendgroupnumber, uint8_t * message, uint16_t length, void *userdata)
- */
-void g_callback_group_message(Group_Chats *g_c, void (*function)(Messenger *m, uint32_t, uint32_t, int, const uint8_t *,
- size_t, void *));
-
-
-/* Set callback function for title changes.
- *
- * Function(Group_Chats *g_c, int groupnumber, int friendgroupnumber, uint8_t * title, uint8_t length, void *userdata)
- * if friendgroupnumber == -1, then author is unknown (e.g. initial joining the group)
- */
-void g_callback_group_title(Group_Chats *g_c, void (*function)(Messenger *m, uint32_t, uint32_t, const uint8_t *,
- size_t, void *));
-
-/* Set callback function for peer name list changes.
- *
- * It gets called every time the name list changes(new peer/name, deleted peer)
- * Function(Group_Chats *g_c, int groupnumber, int peernumber, TOX_CHAT_CHANGE change, void *userdata)
- */
-enum {
- CHAT_CHANGE_PEER_ADD,
- CHAT_CHANGE_PEER_DEL,
- CHAT_CHANGE_PEER_NAME,
-};
-void g_callback_group_namelistchange(Group_Chats *g_c, void (*function)(Messenger *m, int, int, uint8_t, void *));
-
-/* Creates a new groupchat and puts it in the chats array.
- *
- * type is one of GROUPCHAT_TYPE_*
- *
- * return group number on success.
- * return -1 on failure.
- */
-int add_groupchat(Group_Chats *g_c, uint8_t type);
-
-/* Delete a groupchat from the chats array.
- *
- * return 0 on success.
- * return -1 if groupnumber is invalid.
- */
-int del_groupchat(Group_Chats *g_c, int groupnumber);
-
-/* Copy the public key of peernumber who is in groupnumber to pk.
- * pk must be CRYPTO_PUBLIC_KEY_SIZE long.
- *
- * return 0 on success
- * return -1 if groupnumber is invalid.
- * return -2 if peernumber is invalid.
- */
-int group_peer_pubkey(const Group_Chats *g_c, int groupnumber, int peernumber, uint8_t *pk);
-
-/*
- * Return the size of peernumber's name.
- *
- * return -1 if groupnumber is invalid.
- * return -2 if peernumber is invalid.
- */
-int group_peername_size(const Group_Chats *g_c, int groupnumber, int peernumber);
-
-/* Copy the name of peernumber who is in groupnumber to name.
- * name must be at least MAX_NAME_LENGTH long.
- *
- * return length of name if success
- * return -1 if groupnumber is invalid.
- * return -2 if peernumber is invalid.
- */
-int group_peername(const Group_Chats *g_c, int groupnumber, int peernumber, uint8_t *name);
-
-/* invite friendnumber to groupnumber
- *
- * return 0 on success.
- * return -1 if groupnumber is invalid.
- * return -2 if invite packet failed to send.
- */
-int invite_friend(Group_Chats *g_c, int32_t friendnumber, int groupnumber);
-
-/* Join a group (you need to have been invited first.)
- *
- * expected_type is the groupchat type we expect the chat we are joining is.
- *
- * return group number on success.
- * return -1 if data length is invalid.
- * return -2 if group is not the expected type.
- * return -3 if friendnumber is invalid.
- * return -4 if client is already in this group.
- * return -5 if group instance failed to initialize.
- * return -6 if join packet fails to send.
- */
-int join_groupchat(Group_Chats *g_c, int32_t friendnumber, uint8_t expected_type, const uint8_t *data, uint16_t length);
-
-/* send a group message
- * return 0 on success
- * see: send_message_group() for error codes.
- */
-int group_message_send(const Group_Chats *g_c, int groupnumber, const uint8_t *message, uint16_t length);
-
-/* send a group action
- * return 0 on success
- * see: send_message_group() for error codes.
- */
-int group_action_send(const Group_Chats *g_c, int groupnumber, const uint8_t *action, uint16_t length);
-
-/* set the group's title, limited to MAX_NAME_LENGTH
- * return 0 on success
- * return -1 if groupnumber is invalid.
- * return -2 if title is too long or empty.
- * return -3 if packet fails to send.
- */
-int group_title_send(const Group_Chats *g_c, int groupnumber, const uint8_t *title, uint8_t title_len);
-
-
-/* return the group's title size.
- * return -1 of groupnumber is invalid.
- * return -2 if title is too long or empty.
- */
-int group_title_get_size(const Group_Chats *g_c, int groupnumber);
-
-/* Get group title from groupnumber and put it in title.
- * Title needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
- *
- * return length of copied title if success.
- * return -1 if groupnumber is invalid.
- * return -2 if title is too long or empty.
- */
-int group_title_get(const Group_Chats *g_c, int groupnumber, uint8_t *title);
-
-/* Return the number of peers in the group chat on success.
- * return -1 if groupnumber is invalid.
- */
-int group_number_peers(const Group_Chats *g_c, int groupnumber);
-
-/* return 1 if the peernumber corresponds to ours.
- * return 0 if the peernumber is not ours.
- * return -1 if groupnumber is invalid.
- * return -2 if peernumber is invalid.
- * return -3 if we are not connected to the group chat.
- */
-int group_peernumber_is_ours(const Group_Chats *g_c, int groupnumber, int peernumber);
-
-/* List all the peers in the group chat.
- *
- * Copies the names of the peers to the name[length][MAX_NAME_LENGTH] array.
- *
- * Copies the lengths of the names to lengths[length]
- *
- * returns the number of peers on success.
- *
- * return -1 on failure.
- */
-int group_names(const Group_Chats *g_c, int groupnumber, uint8_t names[][MAX_NAME_LENGTH], uint16_t lengths[],
- uint16_t length);
-
-/* Set handlers for custom lossy packets.
- *
- * NOTE: Handler must return 0 if packet is to be relayed, -1 if the packet should not be relayed.
- *
- * Function(void *group object (set with group_set_object), int groupnumber, int friendgroupnumber, void *group peer object (set with group_peer_set_object), const uint8_t *packet, uint16_t length)
- */
-void group_lossy_packet_registerhandler(Group_Chats *g_c, uint8_t byte, int (*function)(void *, int, int, void *,
- const uint8_t *, uint16_t));
-
-/* High level function to send custom lossy packets.
- *
- * return -1 on failure.
- * return 0 on success.
- */
-int send_group_lossy_packet(const Group_Chats *g_c, int groupnumber, const uint8_t *data, uint16_t length);
-
-/* Return the number of chats in the instance m.
- * You should use this to determine how much memory to allocate
- * for copy_chatlist.
- */
-uint32_t count_chatlist(Group_Chats *g_c);
-
-/* Copy a list of valid chat IDs into the array out_list.
- * If out_list is NULL, returns 0.
- * Otherwise, returns the number of elements copied.
- * If the array was too small, the contents
- * of out_list will be truncated to list_size. */
-uint32_t copy_chatlist(Group_Chats *g_c, uint32_t *out_list, uint32_t list_size);
-
-/* return the type of groupchat (GROUPCHAT_TYPE_) that groupnumber is.
- *
- * return -1 on failure.
- * return type on success.
- */
-int group_get_type(const Group_Chats *g_c, int groupnumber);
-
-/* Send current name (set in messenger) to all online groups.
- */
-void send_name_all_groups(Group_Chats *g_c);
-
-/* Set the object that is tied to the group chat.
- *
- * return 0 on success.
- * return -1 on failure
- */
-int group_set_object(const Group_Chats *g_c, int groupnumber, void *object);
-
-/* Set the object that is tied to the group peer.
- *
- * return 0 on success.
- * return -1 on failure
- */
-int group_peer_set_object(const Group_Chats *g_c, int groupnumber, int peernumber, void *object);
-
-/* Return the object tide to the group chat previously set by group_set_object.
- *
- * return NULL on failure.
- * return object on success.
- */
-void *group_get_object(const Group_Chats *g_c, int groupnumber);
-
-/* Return the object tide to the group chat peer previously set by group_peer_set_object.
- *
- * return NULL on failure.
- * return object on success.
- */
-void *group_peer_get_object(const Group_Chats *g_c, int groupnumber, int peernumber);
-
-/* Set a function to be called when a new peer joins a group chat.
- *
- * Function(void *group object (set with group_set_object), int groupnumber, int friendgroupnumber)
- *
- * return 0 on success.
- * return -1 on failure.
- */
-int callback_groupchat_peer_new(const Group_Chats *g_c, int groupnumber, void (*function)(void *, int, int));
-
-/* Set a function to be called when a peer leaves a group chat.
- *
- * Function(void *group object (set with group_set_object), int groupnumber, int friendgroupnumber, void *group peer object (set with group_peer_set_object))
- *
- * return 0 on success.
- * return -1 on failure.
- */
-int callback_groupchat_peer_delete(Group_Chats *g_c, int groupnumber, void (*function)(void *, int, int, void *));
-
-/* Set a function to be called when the group chat is deleted.
- *
- * Function(void *group object (set with group_set_object), int groupnumber)
- *
- * return 0 on success.
- * return -1 on failure.
- */
-int callback_groupchat_delete(Group_Chats *g_c, int groupnumber, void (*function)(void *, int));
-
-/* Create new groupchat instance. */
-Group_Chats *new_groupchats(Messenger *m);
-
-/* main groupchats loop. */
-void do_groupchats(Group_Chats *g_c, void *userdata);
-
-/* Free everything related with group chats. */
-void kill_groupchats(Group_Chats *g_c);
-
-#endif