GNUnet  0.11.x
Typedefs | Functions
transport-testing2.h File Reference

functions and structures related to testing-tng More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_ats_transport_service.h"
#include "transport.h"
Include dependency graph for transport-testing2.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *(* GNUNET_TRANSPORT_TESTING_BackchannelCallback) (void *cls, struct GNUNET_MessageHeader *msg, struct GNUNET_PeerIdentity *pid)
 Function signature for callbacks that are called when new backchannel message arrived. More...
 
typedef void(* GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, char *address_prefix)
 Function signature for callbacks that are called when new communicators become available. More...
 
typedef void(* GNUNET_TRANSPORT_TESTING_AddAddressCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *address, struct GNUNET_TIME_Relative expiration, uint32_t aid, enum GNUNET_NetworkType nt)
 Receive information about the address of a communicator. More...
 
typedef void(* GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, int will_try)
 Get informed about the success of a queue request. More...
 
typedef void(* GNUNET_TRANSPORT_TESTING_AddQueueCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue)
 Handle opening of queue. More...
 
typedef void(* GNUNET_TRANSPORT_TESTING_IncomingMessageCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *payload, size_t payload_len)
 Handle an incoming message. More...
 

Functions

struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandleGNUNET_TRANSPORT_TESTING_transport_communicator_service_start (const char *service_name, const char *binary_name, const char *cfg_filename, GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback communicator_available_cb, GNUNET_TRANSPORT_TESTING_AddAddressCallback add_address_cb, GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback queue_create_reply_cb, GNUNET_TRANSPORT_TESTING_AddQueueCallback add_queue_cb, GNUNET_TRANSPORT_TESTING_IncomingMessageCallback incoming_message_cb, GNUNET_TRANSPORT_TESTING_BackchannelCallback bc_cb, void *cb_cls)
 Start communicator part of transport service and communicator. More...
 
void GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h)
 
void GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const struct GNUNET_PeerIdentity *peer_id, const char *address)
 Instruct communicator to open a queue. More...
 
void GNUNET_TRANSPORT_TESTING_transport_communicator_send (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls, const void *payload, size_t payload_size)
 Instruct communicator to send data. More...
 

Detailed Description

functions and structures related to testing-tng

Author
Christian Grothoff
Julius Bünger

Definition in file transport-testing2.h.

Typedef Documentation

◆ GNUNET_TRANSPORT_TESTING_BackchannelCallback

typedef struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle*(* GNUNET_TRANSPORT_TESTING_BackchannelCallback) (void *cls, struct GNUNET_MessageHeader *msg, struct GNUNET_PeerIdentity *pid)

Function signature for callbacks that are called when new backchannel message arrived.

Parameters
clsClosure
msgBackchannel message
pidTarget peer

Definition at line 59 of file transport-testing2.h.

◆ GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback

typedef void(* GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, char *address_prefix)

Function signature for callbacks that are called when new communicators become available.

Parameters
clsClosure
tc_hCommunicator handle
ccCharacteristics of communicator
address_prefixPrefix of the address

Definition at line 74 of file transport-testing2.h.

◆ GNUNET_TRANSPORT_TESTING_AddAddressCallback

typedef void(* GNUNET_TRANSPORT_TESTING_AddAddressCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *address, struct GNUNET_TIME_Relative expiration, uint32_t aid, enum GNUNET_NetworkType nt)

Receive information about the address of a communicator.

Parameters
clsClosure
tc_hCommunicator handle
addressAddress represented as string
expirationExpiration
aidAid
ntNetwork Type

Definition at line 95 of file transport-testing2.h.

◆ GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback

typedef void(* GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, int will_try)

Get informed about the success of a queue request.

Parameters
clsClosure
tc_hCommunicator handle
will_tryGNUNET_YES if communicator will try to create queue

Definition at line 114 of file transport-testing2.h.

◆ GNUNET_TRANSPORT_TESTING_AddQueueCallback

typedef void(* GNUNET_TRANSPORT_TESTING_AddQueueCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue)

Handle opening of queue.

Parameters
clsClosure
tc_hCommunicator handle
tc_queueHandle to newly opened queue

Definition at line 129 of file transport-testing2.h.

◆ GNUNET_TRANSPORT_TESTING_IncomingMessageCallback

typedef void(* GNUNET_TRANSPORT_TESTING_IncomingMessageCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *payload, size_t payload_len)

Handle an incoming message.

Parameters
clsClosure
tc_hHandle to the receiving communicator
msgReceived message

Definition at line 146 of file transport-testing2.h.

Function Documentation

◆ GNUNET_TRANSPORT_TESTING_transport_communicator_service_start()

struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle* GNUNET_TRANSPORT_TESTING_transport_communicator_service_start ( const char *  service_name,
const char *  binary_name,
const char *  cfg_filename,
GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback  communicator_available_cb,
GNUNET_TRANSPORT_TESTING_AddAddressCallback  add_address_cb,
GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback  queue_create_reply_cb,
GNUNET_TRANSPORT_TESTING_AddQueueCallback  add_queue_cb,
GNUNET_TRANSPORT_TESTING_IncomingMessageCallback  incoming_message_cb,
GNUNET_TRANSPORT_TESTING_BackchannelCallback  bc_cb,
void *  cb_cls 
)

Start communicator part of transport service and communicator.

Parameters
service_nameName of the service
cfgConfiguration handle
communicator_availableCallback that is called when a new communicator becomes available
add_address_cbCallback handling new addresses
queue_create_reply_cbCallback handling success of queue requests
add_queue_cbCallback handling freshly created queues
incoming_message_cbCallback handling incoming messages
cb_clsClosure to communicator_available
Returns
Handle to the communicator duo
Parameters
service_nameName of the service
cfgConfiguration handle
communicator_available_cbCallback that is called when a new
add_address_cbCallback that is called when a new communicator becomes available
cb_clsClosure to communicator_available_cb and
Returns
Handle to the communicator duo

Definition at line 933 of file transport-testing2.c.

References _, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::add_address_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::add_queue_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::bc_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::bc_enabled, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cb_cls, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg_filename, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::communicator_available_cb, communicator_start(), GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_load(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_new, GNUNET_strdup, GNUNET_SYSERR, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::incoming_msg_cb, LOG, nat_start(), GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_create_reply_cb, and transport_communicator_start().

945 {
947 
949  "Starting new transport/communicator combo with config %s\n",
950  cfg_filename);
951  tc_h =
954  tc_h->cfg = GNUNET_CONFIGURATION_create ();
956  {
958  _ ("Malformed configuration file `%s', exit ...\n"),
959  cfg_filename);
960  GNUNET_free (tc_h->cfg_filename);
962  GNUNET_free (tc_h);
963  return NULL;
964  }
966  "communicator-test",
967  "BACKCHANNEL_ENABLED");
971  tc_h->add_queue_cb = add_queue_cb;
972  tc_h->incoming_msg_cb = incoming_message_cb;
973  tc_h->bc_cb = bc_cb;
974  tc_h->cb_cls = cb_cls;
975 
976  /* Start communicator part of service */
978  /* Start NAT */
979  nat_start (tc_h);
980  /* Schedule start communicator */
981  communicator_start (tc_h,
982  binary_name);
983  return tc_h;
984 }
static char * cfg_filename
Name of the configuration file.
static void nat_start(struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h)
Start NAT.
char * cfg_filename
File name of configuration file.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback communicator_available_cb
Callback called when a new communicator connects.
int GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
#define _(String)
GNU gettext support macro.
Definition: platform.h:180
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
GNUNET_TRANSPORT_TESTING_AddAddressCallback add_address_cb
Callback called when a new communicator connects.
struct GNUNET_CONFIGURATION_Handle * cfg
Handle to the configuration.
#define GNUNET_SYSERR
Definition: gnunet_common.h:84
GNUNET_TRANSPORT_TESTING_IncomingMessageCallback incoming_msg_cb
Callback called when a new communicator connects.
static void communicator_start(struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *binary_name)
Start the communicator.
#define GNUNET_log(kind,...)
GNUNET_TRANSPORT_TESTING_AddQueueCallback add_queue_cb
Callback called when a new communicator connects.
GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback queue_create_reply_cb
Callback called when a new communicator connects.
GNUNET_TRANSPORT_TESTING_BackchannelCallback bc_cb
Backchannel callback.
static void transport_communicator_start(struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h)
Start the communicator part of the transport service.
int GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
#define LOG(kind,...)
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:

◆ GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop()

void GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop ( struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle tc_h)

Definition at line 988 of file transport-testing2.c.

References GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_proc, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg, GNUNET_CONFIGURATION_destroy(), GNUNET_free, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::nat_proc, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::sh, shutdown_communicator(), shutdown_nat(), and shutdown_service().

990 {
992  shutdown_service (tc_h->sh);
993  shutdown_nat (tc_h->nat_proc);
995  GNUNET_free (tc_h);
996 }
static void shutdown_communicator(void *cls)
static void shutdown_nat(void *cls)
Task run at shutdown to kill communicator and clean up.
struct GNUNET_SERVICE_Handle * sh
Our service handle.
struct GNUNET_OS_Process * nat_proc
NAT process.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
struct GNUNET_CONFIGURATION_Handle * cfg
Handle to the configuration.
struct GNUNET_OS_Process * c_proc
Process of the communicator.
static void shutdown_service(void *cls)
Shut down the service.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:

◆ GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue()

void GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue ( struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle tc_h,
const struct GNUNET_PeerIdentity peer_id,
const char *  address 
)

Instruct communicator to open a queue.

Parameters
tc_hHandle to communicator which shall open queue
peer_idTowards which peer
addressFor which address

Definition at line 1007 of file transport-testing2.c.

References GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_mq, env, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_free, GNUNET_HELLO_address_to_prefix(), GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, GNUNET_TRANSPORT_TESTING_transport_communicator_send(), msg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::open_queue_env, peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::qid, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_head, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_tail, and GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::tc_h.

1011 {
1013  static uint32_t idgen;
1014  char *prefix;
1015  struct GNUNET_TRANSPORT_CreateQueue *msg;
1016  struct GNUNET_MQ_Envelope *env;
1017  size_t alen;
1018 
1019  tc_queue =
1021  tc_queue->tc_h = tc_h;
1023  if (NULL == prefix)
1024  {
1025  GNUNET_break (0); /* We got an invalid address!? */
1026  GNUNET_free (tc_queue);
1027  return;
1028  }
1029  GNUNET_free (prefix);
1030  alen = strlen (address) + 1;
1031  env =
1033  msg->request_id = htonl (idgen++);
1034  tc_queue->qid = msg->request_id;
1035  msg->receiver = *peer_id;
1036  tc_queue->peer_id = *peer_id;
1037  memcpy (&msg[1], address, alen);
1038  if (NULL != tc_h->c_mq)
1039  {
1040  GNUNET_MQ_send (tc_h->c_mq, env);
1041  }
1042  else
1043  {
1044  tc_queue->open_queue_env = env;
1045  }
1046  GNUNET_CONTAINER_DLL_insert (tc_h->queue_head, tc_h->queue_tail, tc_queue);
1047 }
struct GNUNET_PeerIdentity peer_id
Peer ID of the peer on the other side of the queue.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
#define GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE
transport tells communicator it wants a queue
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
static char * peer_id
Option –peer.
Definition: gnunet-cadet.c:42
struct GNUNET_MQ_Handle * c_mq
Handle to the client.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
char * GNUNET_HELLO_address_to_prefix(const char *address)
Given an address as a string, extract the prefix that identifies the communicator offering transmissi...
Definition: hello-ng.c:191
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue * queue_tail
Tail of the DLL of queues associated with this communicator.
struct GNUNET_MQ_Envelope * open_queue_env
Envelope to a message that requests the opening of the queue.
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue * queue_head
Head of the DLL of queues associated with this communicator.
static char * address
GNS address for this phone.
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle * tc_h
Handle to the TransportCommunicator.
#define GNUNET_free(ptr)
Wrapper around free.
Queue of a communicator and some context.
Here is the call graph for this function:

◆ GNUNET_TRANSPORT_TESTING_transport_communicator_send()

void GNUNET_TRANSPORT_TESTING_transport_communicator_send ( struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue tc_queue,
GNUNET_SCHEDULER_TaskCallback  cont,
void *  cont_cls,
const void *  payload,
size_t  payload_size 
)

Instruct communicator to send data.

Parameters
tc_queueThe queue to use for sending
contfunction to call when done sending
cont_clsclosure for cont
payloadData to send
payload_sizeSize of the payload

Definition at line 1061 of file transport-testing2.c.

References GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_mq, env, GNUNET_MESSAGE_TYPE_DUMMY, GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG, GNUNET_MQ_msg_extra, GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), mh, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::mid, msg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::qid, GNUNET_MessageHeader::size, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::tc_h, and GNUNET_MessageHeader::type.

Referenced by GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue().

1066 {
1067  struct GNUNET_MessageHeader *mh;
1068  struct GNUNET_TRANSPORT_SendMessageTo *msg;
1069  struct GNUNET_MQ_Envelope *env;
1070  size_t inbox_size;
1071 
1072  inbox_size = sizeof (struct GNUNET_MessageHeader) + payload_size;
1073  env = GNUNET_MQ_msg_extra (msg,
1074  inbox_size,
1076  msg->qid = htonl (tc_queue->qid);
1077  msg->mid = tc_queue->mid++;
1078  msg->receiver = tc_queue->peer_id;
1079  mh = (struct GNUNET_MessageHeader *) &msg[1];
1080  mh->size = htons (inbox_size);
1082  memcpy (&mh[1],
1083  payload,
1084  payload_size);
1085  if (NULL != cont)
1086  GNUNET_MQ_notify_sent (env,
1087  cont,
1088  cont_cls);
1089  GNUNET_MQ_send (tc_queue->tc_h->c_mq,
1090  env);
1091 }
struct GNUNET_PeerIdentity peer_id
Peer ID of the peer on the other side of the queue.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG
transport tells communicator it wants to transmit
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
#define GNUNET_MESSAGE_TYPE_DUMMY
Dummy messages for testing / benchmarking.
struct GNUNET_MQ_Handle * c_mq
Handle to the client.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
void GNUNET_MQ_notify_sent(struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore...
Definition: mq.c:783
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static unsigned long long payload
How much data are we currently storing in the database?
Header for all communications.
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle * tc_h
Handle to the TransportCommunicator.
Here is the call graph for this function:
Here is the caller graph for this function: