src/testbed/testbed_api_topology.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 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 /**
  22  * @file testbed/testbed_api_topology.h
  23  * @brief header for intra library exported functions
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #ifndef TESTBED_API_TOPOLOGY_H
  28 #define TESTBED_API_TOPOLOGY_H
  29
  30 /**
  31  * Returns the number of links that are required to generate a 2d torus for the
  32  * given number of peers. Also returns the arrangment (number of rows and the
  33  * length of each row)
  34  *
  35  * @param num_peers number of peers
  36  * @param rows number of rows in the 2d torus. Can be NULL.
  37  * @param rows_len the length of each row. This array will be allocated
  38  *          fresh. The caller should free it. Can be NULL.
  39  */
  40 unsigned int
  41 GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers,
  42                                    unsigned int *rows,
  43                                    unsigned int **rows_len);
  44
  45
  46 /**
  47  * Get a topology from a string input.
  48  *
  49  * @param topology where to write the retrieved topology
  50  * @param topology_string The string to attempt to
  51  *        get a configuration value from
  52  * @return GNUNET_YES if topology string matched a
  53  *         known topology, GNUNET_NO if not
  54  */
  55 int
  56 GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
  57                               const char *topology_string);
  58
  59
  60 /**
  61  * Returns the string corresponding to the given topology
  62  *
  63  * @param topology the topology
  64  * @return the string (freshly allocated) of given topology; NULL if topology cannot be
  65  *           expressed as a string
  66  */
  67 char *
  68 GNUNET_TESTBED_topology_to_str_ (enum GNUNET_TESTBED_TopologyOption topology);
  69
  70 #endif
  71 /* end of  testbed_api_topology.h */
  72