/*
This file is part of GNUnet.
Copyright (C) 2020--2021 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @author Tobias Frisch
* @file src/messenger/messenger_api_room.h
* @brief messenger api: client implementation of GNUnet MESSENGER service
*/
#ifndef GNUNET_MESSENGER_API_ROOM_H
#define GNUNET_MESSENGER_API_ROOM_H
#include "platform.h"
#include "gnunet_container_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_messenger_service.h"
#include "messenger_api_list_tunnels.h"
#include "messenger_api_contact.h"
#include "messenger_api_message.h"
struct GNUNET_MESSENGER_RoomMessageEntry {
struct GNUNET_MESSENGER_Contact* sender;
struct GNUNET_MESSENGER_Message* message;
};
struct GNUNET_MESSENGER_Room
{
struct GNUNET_MESSENGER_Handle *handle;
struct GNUNET_HashCode key;
int opened;
struct GNUNET_ShortHashCode *contact_id;
struct GNUNET_MESSENGER_ListTunnels entries;
struct GNUNET_CONTAINER_MultiHashMap *messages;
struct GNUNET_CONTAINER_MultiShortmap *members;
};
/**
* Creates and allocates a new room for a handle with a given key for the client API.
*
* @param[in/out] handle Handle
* @param[in] key Key of room
* @return New room
*/
struct GNUNET_MESSENGER_Room*
create_room (struct GNUNET_MESSENGER_Handle *handle,
const struct GNUNET_HashCode *key);
/**
* Destroys a room and frees its memory fully from the client API.
*
* @param[in/out] room Room
*/
void
destroy_room (struct GNUNET_MESSENGER_Room *room);
/**
* Returns a message locally stored from a map for a given hash in a room. If no matching
* message is found, NULL gets returned.
*
* @param[in] room Room
* @param[in] hash Hash of message
* @return Message or NULL
*/
const struct GNUNET_MESSENGER_Message*
get_room_message (const struct GNUNET_MESSENGER_Room *room,
const struct GNUNET_HashCode *hash);
/**
* Returns a messages sender locally stored from a map for a given hash in a room. If no
* matching message is found, NULL gets returned.
*
* @param[in] room Room
* @param[in] hash Hash of message
* @return Contact of sender or NULL
*/
struct GNUNET_MESSENGER_Contact*
get_room_sender (const struct GNUNET_MESSENGER_Room *room,
const struct GNUNET_HashCode *hash);
/**
* Handles a message with a given hash in a room for the client API to update
* members and its information. The function also stores the message in map locally for access afterwards.
*
* The contact of the message's sender could be updated or even created. It may not be freed or destroyed though!
* (The contact may still be in use for old messages...)
*
* @param[in/out] room Room
* @param[in/out] sender Contact of sender
* @param[in] message Message
* @param[in] hash Hash of message
* @return Contact of sender
*/
struct GNUNET_MESSENGER_Contact*
handle_room_message (struct GNUNET_MESSENGER_Room *room,
struct GNUNET_MESSENGER_Contact *sender,
const struct GNUNET_MESSENGER_Message *message,
const struct GNUNET_HashCode *hash);
/**
* Iterates through all members of a given room to forward each of them to a selected
* callback with a custom closure.
*
* @param[in/out] room Room
* @param[in] callback Function called for each member
* @param[in/out] cls Closure
* @return Amount of members iterated
*/
int
iterate_room_members (struct GNUNET_MESSENGER_Room *room,
GNUNET_MESSENGER_MemberCallback callback,
void* cls);
/**
* Checks through all members of a given room if a specific contact is found and
* returns a result depending on that.
*
* @param[in] room Room
* @param[in] contact
* @return #GNUNET_YES if found, otherwise #GNUNET_NO
*/
int
find_room_member (const struct GNUNET_MESSENGER_Room *room,
const struct GNUNET_MESSENGER_Contact *contact);
#endif //GNUNET_MESSENGER_API_ROOM_H