messenger_api_epoch_membership.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 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_MEMBERSHIP_H
#define GNUNET_MESSENGER_API_EPOCH_MEMBERSHIP_H
 
#include "gnunet_common.h"
#include "gnunet_time_lib.h"
#include "gnunet_util_lib.h"
 
#include "gnunet_messenger_service.h"
 
struct GNUNET_MESSENGER_EpochMembership
{
  uint32_t size;
  uint32_t count;
 
  struct GNUNET_CONTAINER_MultiHashMap *members;
  struct GNUNET_HashCode announcement;
};
 
typedef enum GNUNET_GenericReturnValue (*GNUNET_MESSENGER_MembershipCallback)
  (void *cls, const struct GNUNET_MESSENGER_Contact *member);
 
struct GNUNET_MESSENGER_EpochMembership*
create_epoch_membership (uint32_t size);
 
void
destroy_epoch_membership (struct GNUNET_MESSENGER_EpochMembership *membership);
 
uint32_t
get_epoch_membership_size (const struct GNUNET_MESSENGER_EpochMembership *
                           membership);
 
uint32_t
get_epoch_membership_count (const struct GNUNET_MESSENGER_EpochMembership *
                            membership);
 
enum GNUNET_GenericReturnValue
is_epoch_membership_completed (const struct GNUNET_MESSENGER_EpochMembership *
                               membership);
 
enum GNUNET_GenericReturnValue
is_epoch_membership_member (const struct GNUNET_MESSENGER_EpochMembership *
                            membership,
                            const struct GNUNET_MESSENGER_Contact *contact);
 
enum GNUNET_GenericReturnValue
get_epoch_membership_member_hash (const struct
                                  GNUNET_MESSENGER_EpochMembership *membership,
                                  struct GNUNET_HashCode *hash,
                                  enum GNUNET_GenericReturnValue other);
 
uint32_t
get_epoch_membership_member_position (const struct
                                      GNUNET_MESSENGER_EpochMembership *
                                      membership);
 
enum GNUNET_GenericReturnValue
confirm_epoch_membership_announcment (struct GNUNET_MESSENGER_EpochMembership *
                                      membership,
                                      const struct GNUNET_HashCode *hash,
                                      const struct GNUNET_MESSENGER_Message *
                                      message,
                                      struct GNUNET_MESSENGER_Contact *contact,
                                      enum GNUNET_GenericReturnValue sent);
 
enum GNUNET_GenericReturnValue
revoke_epoch_membership_announcement (struct GNUNET_MESSENGER_EpochMembership *
                                      membership,
                                      const struct GNUNET_HashCode *hash,
                                      struct GNUNET_MESSENGER_Contact *contact);
 
int
iterate_epoch_membership_members (const struct
                                  GNUNET_MESSENGER_EpochMembership *membership,
                                  GNUNET_MESSENGER_MembershipCallback callback,
                                  void *cls);
 
#endif // GNUNET_MESSENGER_API_EPOCH_MEMBERSHIP_H