src/regex/regex_ipc.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012, 2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file regex/regex_ipc.h
  22  * @brief regex IPC messages (not called 'regex.h' due to conflict with
  23  *        system headers)
  24  * @author Christian Grothoff
  25  */
  26 #ifndef REGEX_IPC_H
  27 #define REGEX_IPC_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31 /**
  32  * Request for regex service to announce capability.
  33  */
  34 struct AnnounceMessage
  35 {
  36
  37   /**
  38    * Type is GNUNET_MESSAGE_TYPE_REGEX_ANNOUNCE
  39    */
  40   struct GNUNET_MessageHeader header;
  41
  42   /**
  43    * How many characters can we squeeze per edge?
  44    */
  45   uint16_t compression;
  46
  47   /**
  48    * Always zero.
  49    */
  50   uint16_t reserved;
  51
  52   /**
  53    * Delay between repeated announcements.
  54    */
  55   struct GNUNET_TIME_RelativeNBO refresh_delay;
  56
  57   /* followed by 0-terminated regex as string */
  58 };
  59
  60
  61 /**
  62  * Message to initiate regex search.
  63  */
  64 struct SearchMessage
  65 {
  66   /**
  67    * Type is GNUNET_MESSAGE_TYPE_REGEX_SEARCH
  68    */
  69   struct GNUNET_MessageHeader header;
  70
  71   /* followed by 0-terminated search string */
  72
  73 };
  74
  75
  76 /**
  77  * Result from regex search.
  78  */
  79 struct ResultMessage
  80 {
  81   /**
  82    * Type is GNUNET_MESSAGE_TYPE_REGEX_RESULT
  83    */
  84   struct GNUNET_MessageHeader header;
  85
  86   /**
  87    * Number of entries in the GET path.
  88    */
  89   uint16_t get_path_length;
  90
  91   /**
  92    * Number of entries in the PUT path.
  93    */
  94   uint16_t put_path_length;
  95
  96   /**
  97    * Identity of the peer that was found.
  98    */
  99   struct GNUNET_PeerIdentity id;
 100
 101   /* followed by GET path and PUT path arrays */
 102
 103 };
 104
 105
 106 /* end of regex_ipc.h */
 107 #endif