src/peerinfo/peerinfo.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file peerinfo/peerinfo.h
  23  * @brief common internal definitions for peerinfo service
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef PEERINFO_H
  28 #define PEERINFO_H
  29
  30 #include "gnunet_crypto_lib.h"
  31 #include "gnunet_time_lib.h"
  32 #include "gnunet_peerinfo_service.h"
  33
  34
  35 GNUNET_NETWORK_STRUCT_BEGIN
  36
  37 /**
  38  * Message requesting a listing of peers,
  39  * restricted to the specified peer identity.
  40  */
  41 struct ListPeerMessage
  42 {
  43   /**
  44    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_GET
  45    */
  46   struct GNUNET_MessageHeader header;
  47
  48   /**
  49    * Include friend only HELLOs and peers in callbacks
  50    */
  51   uint32_t include_friend_only GNUNET_PACKED;
  52
  53   /**
  54    * Restrict to peers with this identity (optional
  55    * field, check header.size!).
  56    */
  57   struct GNUNET_PeerIdentity peer;
  58 };
  59
  60 /**
  61  * Message requesting a listing of all peers,
  62  * restricted to the specified peer identity.
  63  */
  64 struct ListAllPeersMessage
  65 {
  66   /**
  67    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL
  68    */
  69   struct GNUNET_MessageHeader header;
  70
  71   /**
  72    * Include friend only HELLOs and peers in callbacks
  73    */
  74   uint32_t include_friend_only GNUNET_PACKED;
  75 };
  76
  77
  78 /**
  79  * Header for all communications.
  80  */
  81 struct NotifyMessage
  82 {
  83   /**
  84    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY
  85    */
  86   struct GNUNET_MessageHeader header;
  87
  88   /**
  89    * Include friend only HELLOs and peers in callbacks
  90    */
  91   uint32_t include_friend_only GNUNET_PACKED;
  92 };
  93
  94
  95 /**
  96  * Message used to inform the client about
  97  * a particular peer; this message is optionally followed
  98  * by a HELLO message for the respective peer (if available).
  99  * Check the header.size field to see if a HELLO is
 100  * present.
 101  */
 102 struct InfoMessage
 103 {
 104   /**
 105    * Type will be GNUNET_MESSAGE_TYPE_PEERINFO_INFO
 106    */
 107   struct GNUNET_MessageHeader header;
 108
 109   /**
 110    * Always zero.
 111    */
 112   uint32_t reserved GNUNET_PACKED;
 113
 114   /**
 115    * About which peer are we talking here?
 116    */
 117   struct GNUNET_PeerIdentity peer;
 118 };
 119 GNUNET_NETWORK_STRUCT_END
 120
 121 /*#ifndef PEERINFO_H*/
 122 #endif
 123 /* end of peerinfo.h */