messenger_api_epoch.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2024--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_EPOCH_H
#define GNUNET_MESSENGER_API_EPOCH_H
 
#include "gnunet_common.h"
#include "gnunet_time_lib.h"
#include "gnunet_util_lib.h"
 
#include "messenger_api_epoch_announcement.h"
#include "messenger_api_epoch_group.h"
 
struct GNUNET_MESSENGER_Room;
struct GNUNET_MESSENGER_EpochAnnouncement;
struct GNUNET_MESSENGER_EpochGroup;
 
struct GNUNET_MESSENGER_Epoch
{
  struct GNUNET_HashCode hash;
  struct GNUNET_TIME_Absolute private_key_expiration;
  struct GNUNET_TIME_Absolute proposal_expiration;
 
  struct GNUNET_MESSENGER_Room *room;
 
  struct GNUNET_CRYPTO_EcdhePrivateKey *private_key;
 
  struct GNUNET_CONTAINER_MultiHashMap *waiting;
  struct GNUNET_CONTAINER_MultiShortmap *announcements;
  struct GNUNET_CONTAINER_MultiShortmap *groups;
  struct GNUNET_CONTAINER_MultiShortmap *nonces;
 
  uint32_t members_count;
  const struct GNUNET_MESSENGER_Contact **members;
 
  struct GNUNET_MESSENGER_EpochAnnouncement *main_announcement;
  struct GNUNET_MESSENGER_EpochGroup *main_group;
 
  struct GNUNET_HashCode proposal_hash;
  struct GNUNET_SCHEDULER_Task *proposal_timeout;
 
  uint32_t following_count;
  struct GNUNET_MESSENGER_Epoch **following;
};
 
struct GNUNET_MESSENGER_Epoch*
create_epoch (struct GNUNET_MESSENGER_Room *room,
              const struct GNUNET_HashCode *hash);
 
struct GNUNET_MESSENGER_Epoch*
create_new_epoch (struct GNUNET_MESSENGER_Room *room,
                  const struct GNUNET_HashCode *hash);
 
void
destroy_epoch (struct GNUNET_MESSENGER_Epoch *epoch);
 
uint32_t
get_epoch_size (const struct GNUNET_MESSENGER_Epoch *epoch);
 
void
reset_epoch_size (struct GNUNET_MESSENGER_Epoch *epoch);
 
enum GNUNET_GenericReturnValue
delay_epoch_message_for_its_members (struct GNUNET_MESSENGER_Epoch *epoch,
                                     const struct GNUNET_HashCode *hash);
 
const struct GNUNET_CRYPTO_EcdhePrivateKey*
get_epoch_private_key (struct GNUNET_MESSENGER_Epoch *epoch,
                       const struct GNUNET_TIME_Relative timeout);
 
const struct GNUNET_TIME_Relative
get_epoch_private_key_timeout (const struct GNUNET_MESSENGER_Epoch *epoch);
 
struct GNUNET_MESSENGER_EpochAnnouncement*
get_epoch_announcement (struct GNUNET_MESSENGER_Epoch *epoch,
                        const union GNUNET_MESSENGER_EpochIdentifier *
                        identifier,
                        enum GNUNET_GenericReturnValue valid);
 
struct GNUNET_MESSENGER_EpochGroup*
get_epoch_group (struct GNUNET_MESSENGER_Epoch *epoch,
                 const union GNUNET_MESSENGER_EpochIdentifier *identifier,
                 enum GNUNET_GenericReturnValue valid);
 
enum GNUNET_GenericReturnValue
is_epoch_previous_of_other (const struct GNUNET_MESSENGER_Epoch *epoch,
                            const struct GNUNET_MESSENGER_Epoch *other);
 
const struct GNUNET_MESSENGER_EpochAnnouncement*
get_epoch_previous_announcement (struct GNUNET_MESSENGER_Epoch *epoch,
                                 const union GNUNET_MESSENGER_EpochIdentifier *
                                 identifier);
 
const struct GNUNET_MESSENGER_EpochGroup*
get_epoch_previous_group (struct GNUNET_MESSENGER_Epoch *epoch,
                          const union GNUNET_MESSENGER_EpochIdentifier *
                          identifier);
 
uint32_t
get_epoch_member_position (const struct GNUNET_MESSENGER_Epoch *epoch,
                           const struct GNUNET_MESSENGER_Contact *contact);
 
enum GNUNET_GenericReturnValue
is_epoch_member (const struct GNUNET_MESSENGER_Epoch *epoch,
                 const struct GNUNET_MESSENGER_Contact *contact);
 
double
get_epoch_position_factor (const struct GNUNET_MESSENGER_Epoch *epoch,
                           const struct GNUNET_MESSENGER_Contact *contact,
                           const struct GNUNET_MESSENGER_EpochMembership *
                           membership);
 
void
send_epoch_message (const struct GNUNET_MESSENGER_Epoch *epoch,
                    struct GNUNET_MESSENGER_Message *message);
 
void
update_epoch_announcement (struct GNUNET_MESSENGER_Epoch *epoch,
                           struct GNUNET_MESSENGER_EpochAnnouncement *
                           announcement);
 
void
update_epoch_group (struct GNUNET_MESSENGER_Epoch *epoch,
                    struct GNUNET_MESSENGER_EpochGroup *group);
 
void
propose_epoch_group (struct GNUNET_MESSENGER_Epoch *epoch,
                     const struct GNUNET_TIME_Relative timeout);
 
void
set_epoch_proposal_group (struct GNUNET_MESSENGER_Epoch *epoch,
                          const struct GNUNET_HashCode *hash);
 
const struct GNUNET_MESSENGER_EpochGroup*
get_epoch_proposal_group (struct GNUNET_MESSENGER_Epoch *epoch);
 
void
cancel_epoch_proposal_group (struct GNUNET_MESSENGER_Epoch *epoch);
 
void
invalidate_epoch_keys_by_member (struct GNUNET_MESSENGER_Epoch *epoch,
                                 const struct GNUNET_MESSENGER_Contact *
                                 contact);
 
#endif // GNUNET_MESSENGER_API_EPOCH_H