aboutsummaryrefslogtreecommitdiff
path: root/src/testbed/testbed_helper.h
blob: 84059fef210b364891d836c0fea3bd93e60cc1aa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
      This file is part of GNUnet
      Copyright (C) 2008--2013 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
 */

/**
 * @file testbed/testbed_helper.h
 * @brief Message formats for communication between testbed api and
 *          gnunet-helper-testbed process
 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
 */

#ifndef TESTBED_HELPER_H
#define TESTBED_HELPER_H

GNUNET_NETWORK_STRUCT_BEGIN
/**
 * Initialization message for gnunet-helper-testbed to start testbed service
 */
struct GNUNET_TESTBED_HelperInit
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT
   */
  struct GNUNET_MessageHeader header;

  /**
   * The controller hostname size excluding the NULL termination character -
   * strlen (hostname); cannot be zero
   */
  uint16_t trusted_ip_size GNUNET_PACKED;

  /**
   * The hostname size excluding the NULL termination character - strlen
   * (hostname); cannot be zero
   */
  uint16_t hostname_size GNUNET_PACKED;

  /**
   * The size of the uncompressed configuration
   */
  uint16_t config_size GNUNET_PACKED;

  /* Followed by NULL terminated trusted ip */

  /* Followed by hostname of the machine on which helper runs. This is not NULL
   * terminated */

  /* Followed by serialized and compressed configuration which should be
   * config_size long when un-compressed */
};

/**
 * Reply message from helper process
 */
struct GNUNET_TESTBED_HelperReply
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY
   */
  struct GNUNET_MessageHeader header;

  /**
   * Size of the uncompressed configuration
   */
  uint16_t config_size GNUNET_PACKED;

  /* Followed by compressed configuration which should be config_size long when
   * un-compressed */
};

/**
 * Initialization message for gnunet-cmds-testbed to start cmd binary.
 */
struct GNUNET_CMDS_HelperInit
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_CMDS_HELPER_INIT
   */
  struct GNUNET_MessageHeader header;

  /**
   *
   */
  uint16_t plugin_name_size GNUNET_PACKED;

  /* Followed by plugin name of the plugin running the test case. This is not NULL
   * terminated */
};

/**
 * Reply message from cmds helper process
 */
struct GNUNET_CMDS_HelperReply
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_CMDS_HELPER_REPLY
   */
  struct GNUNET_MessageHeader header;
};

struct GNUNET_CMDS_PEER_STARTED
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_CMDS_HELPER_PEER_STARTED
   */
  struct GNUNET_MessageHeader header;
};

struct GNUNET_CMDS_ALL_PEERS_STARTED
{
  /**
   * Type is GNUNET_MESSAGE_TYPE_CMDS_HELPER_ALL_PEERS_STARTED
   */
  struct GNUNET_MessageHeader header;
};

GNUNET_NETWORK_STRUCT_END
#endif
/* end of testbed_helper.h */