GNUnet  0.11.x
gnunet_transport_communication_service.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009-2019 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 
35 #ifndef GNUNET_TRANSPORT_COMMUNICATION_SERVICE_H
36 #define GNUNET_TRANSPORT_COMMUNICATION_SERVICE_H
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #if 0 /* keep Emacsens' auto-indent happy */
41 }
42 #endif
43 #endif
44 
45 #include "gnunet_util_lib.h"
46 #include "gnunet_nt_lib.h"
47 
51 #define GNUNET_TRANSPORT_COMMUNICATION_VERSION 0x00000000
52 
53 
73  void *cls,
74  const struct GNUNET_PeerIdentity *peer,
75  const char *address);
76 
77 
82 
83 
91 {
96 
101 
106 };
107 
108 
125  void *cls,
126  const struct GNUNET_PeerIdentity *sender,
127  const struct GNUNET_MessageHeader *msg);
128 
129 
148  const struct GNUNET_CONFIGURATION_Handle *cfg,
149  const char *config_section_name,
150  const char *addr_prefix,
153  void *mq_init_cls,
155  void *notify_cb_cls);
156 
157 
163 void
166 
167 
168 /* ************************* Receiving *************************** */
169 
179 typedef void (*GNUNET_TRANSPORT_MessageCompletedCallback) (void *cls,
180  int success);
181 
182 
203 int
206  const struct GNUNET_PeerIdentity *sender,
207  const struct GNUNET_MessageHeader *msg,
208  struct GNUNET_TIME_Relative expected_addr_validity,
210  void *cb_cls);
211 
212 
213 /* ************************* Discovery *************************** */
214 
220 
221 
226 {
231 
236 
241 };
242 
243 
262  const struct GNUNET_PeerIdentity *peer,
263  const char *address,
264  uint32_t mtu,
265  enum GNUNET_NetworkType nt,
267  struct GNUNET_MQ_Handle *mq);
268 
269 
276 void
278 
279 
285 
286 
299  const char *address,
300  enum GNUNET_NetworkType nt,
302 
303 
310 void
313 
314 
333 void
336  const struct GNUNET_PeerIdentity *pid,
337  const char *comm,
338  const struct GNUNET_MessageHeader *header);
339 
340 
341 #if 0 /* keep Emacsens' auto-indent happy */
342 {
343 #endif
344 #ifdef __cplusplus
345 }
346 #endif
347 
348 /* ifndef GNUNET_TRANSPORT_COMMUNICATOR_SERVICE_H */
349 #endif
350  /* end of group */
352 
353 /* end of gnunet_transport_communicator_service.h */
GNUNET_TRANSPORT_CommunicatorCharacteristics
What characteristics does this communicator have?
Transmission is reliabile (with ACKs), i.e.
static struct GNUNET_CADET_Channel * ch
Channel handle.
Definition: gnunet-cadet.c:117
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
struct GNUNET_TRANSPORT_AddressIdentifier * GNUNET_TRANSPORT_communicator_address_add(struct GNUNET_TRANSPORT_CommunicatorHandle *ch, const char *address, enum GNUNET_NetworkType nt, struct GNUNET_TIME_Relative expiration)
Notify transport service about an address that this communicator provides for this peer...
GNUNET_TRANSPORT_CommunicatorNotify notify_cb
Function to call when the transport service receives messages for a communicator (i.e.
void(* GNUNET_TRANSPORT_CommunicatorNotify)(void *cls, const struct GNUNET_PeerIdentity *sender, const struct GNUNET_MessageHeader *msg)
Function called when the transport service has received a backchannel message for this communicator (...
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
Opaque handle to the transport service for communicators.
void GNUNET_TRANSPORT_communicator_disconnect(struct GNUNET_TRANSPORT_CommunicatorHandle *ch)
Disconnect from the transport service.
enum GNUNET_TRANSPORT_ConnectionStatus cs
Communication status of the queue.
void GNUNET_TRANSPORT_communicator_mq_del(struct GNUNET_TRANSPORT_QueueHandle *qh)
Notify transport service that an MQ became unavailable due to a disconnect or timeout.
int(* GNUNET_TRANSPORT_CommunicatorMqInit)(void *cls, const struct GNUNET_PeerIdentity *peer, const char *address)
Function called by the transport service to initialize a message queue given address information abou...
const char * addr_prefix
Address prefix to use.
void(* GNUNET_TRANSPORT_MessageCompletedCallback)(void *cls, int success)
Function called to notify communicator that we have received and processed the message.
struct GNUNET_TRANSPORT_CommunicatorHandle * GNUNET_TRANSPORT_communicator_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *config_section_name, const char *addr_prefix, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, GNUNET_TRANSPORT_CommunicatorMqInit mq_init, void *mq_init_cls, GNUNET_TRANSPORT_CommunicatorNotify notify_cb, void *notify_cb_cls)
Connect to the transport service.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
this is an inbound connection (communicator initiated)
static char * expiration
Credential TTL.
Definition: gnunet-abd.c:96
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
void GNUNET_TRANSPORT_communicator_address_remove(struct GNUNET_TRANSPORT_AddressIdentifier *ai)
Notify transport service about an address that this communicator no longer provides for this peer...
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
static struct GNUNET_TRANSPORT_AddressIdentifier * ai
Handle to the operation that publishes our address.
static int mq_init(void *cls, const struct GNUNET_PeerIdentity *peer, const char *address)
Function called by the transport service to initialize a message queue given address information abou...
int GNUNET_TRANSPORT_communicator_receive(struct GNUNET_TRANSPORT_CommunicatorHandle *handle, const struct GNUNET_PeerIdentity *sender, const struct GNUNET_MessageHeader *msg, struct GNUNET_TIME_Relative expected_addr_validity, GNUNET_TRANSPORT_MessageCompletedCallback cb, void *cb_cls)
Notify transport service that the communicator has received a message.
Handle to a message queue.
Definition: mq.c:85
The identity of the host (wraps the signing key of the peer).
configuration data
Definition: configuration.c:85
this is an outbound connection (transport initiated)
void GNUNET_TRANSPORT_communicator_notify(struct GNUNET_TRANSPORT_CommunicatorHandle *ch, const struct GNUNET_PeerIdentity *pid, const char *comm, const struct GNUNET_MessageHeader *header)
The communicator asks the transport service to route a message via a different path to another commun...
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
Header for all communications.
struct GNUNET_TRANSPORT_QueueHandle * GNUNET_TRANSPORT_communicator_mq_add(struct GNUNET_TRANSPORT_CommunicatorHandle *ch, const struct GNUNET_PeerIdentity *peer, const char *address, uint32_t mtu, enum GNUNET_NetworkType nt, enum GNUNET_TRANSPORT_ConnectionStatus cs, struct GNUNET_MQ_Handle *mq)
Notify transport service that a MQ became available due to an "inbound" connection or because the com...
GNUNET_TRANSPORT_ConnectionStatus
Possible states of a connection.
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc
Characteristics of the communicator.
static char * address
GNS address for this phone.
uint32_t mtu
Maximum transmission unit for the queue.
Handle returned to identify the internal data structure the transport API has created to manage a mes...
Internal representation of an address a communicator is currently providing for the transport service...
Time for relative time used by GNUnet, in microseconds.