gnunet-service-messenger_message_store.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020--2023 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_SERVICE_MESSENGER_MESSAGE_STORE_H
#define GNUNET_SERVICE_MESSENGER_MESSAGE_STORE_H
 
#include "gnunet_util_lib.h"
 
struct GNUNET_MESSENGER_MessageEntry
{
  off_t offset;
  uint16_t length;
};
 
struct GNUNET_MESSENGER_Message;
 
struct GNUNET_MESSENGER_MessageLink
{
  uint8_t multiple;
 
  struct GNUNET_HashCode first;
  struct GNUNET_HashCode second;
};
 
struct GNUNET_MESSENGER_MessageStore
{
  struct GNUNET_DISK_FileHandle *storage_messages;
 
  struct GNUNET_CONTAINER_MultiHashMap *entries;
  struct GNUNET_CONTAINER_MultiHashMap *messages;
  struct GNUNET_CONTAINER_MultiHashMap *links;
  struct GNUNET_CONTAINER_MultiHashMap *discourses;
 
  enum GNUNET_GenericReturnValue rewrite_entries;
  enum GNUNET_GenericReturnValue write_links;
};
 
void
init_message_store (struct GNUNET_MESSENGER_MessageStore *store);
 
void
clear_message_store (struct GNUNET_MESSENGER_MessageStore *store);
 
void
load_message_store (struct GNUNET_MESSENGER_MessageStore *store,
                    const char *directory);
 
void
save_message_store (struct GNUNET_MESSENGER_MessageStore *store,
                    const char *directory);
 
enum GNUNET_GenericReturnValue
contains_store_message (const struct GNUNET_MESSENGER_MessageStore *store,
                        const struct GNUNET_HashCode *hash);
 
const struct GNUNET_MESSENGER_Message*
get_store_message (struct GNUNET_MESSENGER_MessageStore *store,
                   const struct GNUNET_HashCode *hash);
 
const struct GNUNET_MESSENGER_MessageLink*
get_store_message_link (struct GNUNET_MESSENGER_MessageStore *store,
                        const struct GNUNET_HashCode *hash,
                        enum GNUNET_GenericReturnValue deleted_only);
 
enum GNUNET_GenericReturnValue
put_store_message (struct GNUNET_MESSENGER_MessageStore *store,
                   const struct GNUNET_HashCode *hash,
                   struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
delete_store_message (struct GNUNET_MESSENGER_MessageStore *store,
                      const struct GNUNET_HashCode *hash);
 
void
cleanup_store_discourse_messages_before (struct GNUNET_MESSENGER_MessageStore *store,
                                         const struct GNUNET_ShortHashCode *discourse,
                                         const struct GNUNET_TIME_Absolute timestamp);
 
#endif //GNUNET_SERVICE_MESSENGER_MESSAGE_STORE_H