messenger_api_room.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020--2025 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 <http://www.gnu.org/licenses/>.
 
   SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_MESSENGER_API_ROOM_H
#define GNUNET_MESSENGER_API_ROOM_H
 
#include "gnunet_common.h"
#include "gnunet_time_lib.h"
#include "gnunet_util_lib.h"
 
#include "gnunet_messenger_service.h"
 
#include "messenger_api_handle.h"
#include "messenger_api_list_tunnels.h"
#include "messenger_api_contact.h"
#include "messenger_api_message_control.h"
#include "messenger_api_queue_messages.h"
 
struct GNUNET_MESSENGER_Epoch;
struct GNUNET_MESSENGER_EpochAnnouncement;
 
struct GNUNET_MESSENGER_Room;
 
struct GNUNET_MESSENGER_RoomAction
{
  struct GNUNET_HashCode hash;
 
  struct GNUNET_MESSENGER_Room *room;
  struct GNUNET_SCHEDULER_Task *task;
};
 
struct GNUNET_MESSENGER_RoomMessageEntry
{
  struct GNUNET_MESSENGER_Contact *sender;
  struct GNUNET_MESSENGER_Contact *recipient;
 
  struct GNUNET_MESSENGER_Message *message;
  struct GNUNET_HashCode epoch;
 
  enum GNUNET_MESSENGER_MessageFlags flags;
  enum GNUNET_GenericReturnValue completed;
};
 
struct GNUNET_MESSENGER_RoomSubscription
{
  struct GNUNET_MESSENGER_Room *room;
  struct GNUNET_MESSENGER_Message *message;
  struct GNUNET_SCHEDULER_Task *task;
};
 
struct GNUNET_MESSENGER_Room
{
  struct GNUNET_MESSENGER_Handle *handle;
  union GNUNET_MESSENGER_RoomKey key;
 
  struct GNUNET_HashCode last_message;
  struct GNUNET_HashCode last_epoch;
 
  enum GNUNET_GenericReturnValue joined;
  enum GNUNET_GenericReturnValue opened;
  enum GNUNET_GenericReturnValue use_handle_name;
  enum GNUNET_GenericReturnValue wait_for_sync;
 
  struct GNUNET_ShortHashCode *sender_id;
  struct GNUNET_DISK_FileHandle *keys_file;
 
  struct GNUNET_MESSENGER_ListTunnels entries;
 
  struct GNUNET_CONTAINER_MultiHashMap *actions;
  struct GNUNET_CONTAINER_MultiHashMap *messages;
  struct GNUNET_CONTAINER_MultiShortmap *members;
  struct GNUNET_CONTAINER_MultiHashMap *links;
 
  struct GNUNET_CONTAINER_MultiShortmap *subscriptions;
  struct GNUNET_CONTAINER_MultiHashMap *epochs;
  struct GNUNET_CONTAINER_MultiHashMap *requests;
 
  struct GNUNET_MESSENGER_QueueMessages queue;
  struct GNUNET_SCHEDULER_Task *queue_task;
 
  struct GNUNET_SCHEDULER_Task *request_task;
 
  struct GNUNET_MESSENGER_MessageControl *control;
};
 
typedef void (*GNUNET_MESSENGER_RoomLinkDeletion) (struct
                                                   GNUNET_MESSENGER_Room *room,
                                                   const struct
                                                   GNUNET_HashCode *hash,
                                                   const struct
                                                   GNUNET_TIME_Relative delay);
 
struct GNUNET_MESSENGER_Room*
create_room (struct GNUNET_MESSENGER_Handle *handle,
             const union GNUNET_MESSENGER_RoomKey *key);
 
void
destroy_room (struct GNUNET_MESSENGER_Room *room);
 
const struct GNUNET_HashCode*
get_room_key (const struct GNUNET_MESSENGER_Room *room);
 
enum GNUNET_GenericReturnValue
is_room_public (const struct GNUNET_MESSENGER_Room *room);
 
void
delay_room_action (struct GNUNET_MESSENGER_Room *room,
                   const struct GNUNET_HashCode *hash,
                   const struct GNUNET_TIME_Relative delay);
 
void
cancel_room_action (struct GNUNET_MESSENGER_Room *room,
                    const struct GNUNET_HashCode *hash);
 
void
cancel_room_actions_by (struct GNUNET_MESSENGER_Room *room,
                        enum GNUNET_MESSENGER_MessageKind kind,
                        const struct GNUNET_HashCode *epoch_hash,
                        const union GNUNET_MESSENGER_EpochIdentifier *identifier
                        ,
                        const struct GNUNET_MESSENGER_Contact *contact);
 
enum GNUNET_GenericReturnValue
is_room_available (const struct GNUNET_MESSENGER_Room *room);
 
struct GNUNET_MESSENGER_Handle*
get_room_handle (struct GNUNET_MESSENGER_Room *room);
 
const struct GNUNET_ShortHashCode*
get_room_sender_id (const struct GNUNET_MESSENGER_Room *room);
 
void
set_room_sender_id (struct GNUNET_MESSENGER_Room *room,
                    const struct GNUNET_ShortHashCode *id);
 
struct GNUNET_MESSENGER_Epoch*
get_room_epoch (struct GNUNET_MESSENGER_Room *room,
                const struct GNUNET_HashCode *hash,
                enum GNUNET_GenericReturnValue recent);
 
void
generate_room_epoch_announcement (struct GNUNET_MESSENGER_Room *room,
                                  struct GNUNET_MESSENGER_Epoch *epoch,
                                  struct GNUNET_MESSENGER_EpochAnnouncement **
                                  announcement);
 
struct GNUNET_MESSENGER_Epoch*
get_room_message_epoch (struct GNUNET_MESSENGER_Room *room,
                        const struct GNUNET_HashCode *hash);
 
const union GNUNET_MESSENGER_EpochIdentifier*
get_room_message_epoch_identifier (const struct GNUNET_MESSENGER_Room *room,
                                   const struct GNUNET_HashCode *hash);
 
const struct GNUNET_MESSENGER_Message*
get_room_message (const struct GNUNET_MESSENGER_Room *room,
                  const struct GNUNET_HashCode *hash);
 
enum GNUNET_GenericReturnValue
is_room_message_sent (const struct GNUNET_MESSENGER_Room *room,
                      const struct GNUNET_HashCode *hash);
 
struct GNUNET_MESSENGER_Contact*
get_room_sender (const struct GNUNET_MESSENGER_Room *room,
                 const struct GNUNET_HashCode *hash);
 
struct GNUNET_MESSENGER_Contact*
get_room_recipient (const struct GNUNET_MESSENGER_Room *room,
                    const struct GNUNET_HashCode *hash);
 
const struct GNUNET_HashCode*
get_room_epoch_hash (const struct GNUNET_MESSENGER_Room *room,
                     const struct GNUNET_HashCode *hash);
 
 
void
delete_room_message (struct GNUNET_MESSENGER_Room *room,
                     const struct GNUNET_HashCode *hash,
                     const struct GNUNET_TIME_Relative delay);
 
void
callback_room_message (struct GNUNET_MESSENGER_Room *room,
                       const struct GNUNET_HashCode *hash);
 
void
handle_room_message (struct GNUNET_MESSENGER_Room *room,
                     struct GNUNET_MESSENGER_Contact *sender,
                     const struct GNUNET_MESSENGER_Message *message,
                     const struct GNUNET_HashCode *hash,
                     const struct GNUNET_HashCode *epoch,
                     enum GNUNET_MESSENGER_MessageFlags flags);
 
enum GNUNET_GenericReturnValue
update_room_message (struct GNUNET_MESSENGER_Room *room,
                     const struct GNUNET_HashCode *hash);
 
enum GNUNET_GenericReturnValue
update_room_secret_message (struct GNUNET_MESSENGER_Room *room,
                            const struct GNUNET_HashCode *hash,
                            const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
                            enum GNUNET_GenericReturnValue update);
 
void
update_room_last_message (struct GNUNET_MESSENGER_Room *room,
                          const struct GNUNET_HashCode *hash,
                          const struct GNUNET_HashCode *epoch);
 
void
copy_room_last_message (const struct GNUNET_MESSENGER_Room *room,
                        struct GNUNET_HashCode *hash);
 
int
iterate_room_members (struct GNUNET_MESSENGER_Room *room,
                      GNUNET_MESSENGER_MemberCallback callback,
                      void *cls);
 
enum GNUNET_GenericReturnValue
find_room_member (const struct GNUNET_MESSENGER_Room *room,
                  const struct GNUNET_MESSENGER_Contact *contact);
 
void
link_room_message (struct GNUNET_MESSENGER_Room *room,
                   const struct GNUNET_HashCode *hash,
                   const struct GNUNET_HashCode *other);
 
void
link_room_deletion (struct GNUNET_MESSENGER_Room *room,
                    const struct GNUNET_HashCode *hash,
                    const struct GNUNET_TIME_Relative delay,
                    GNUNET_MESSENGER_RoomLinkDeletion deletion);
 
#endif // GNUNET_MESSENGER_API_ROOM_H