GNUnet 0.21.0
transport_api2_monitor.c File Reference

implementation of the gnunet_transport_monitor_service.h API More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_transport_monitor_service.h"
#include "transport.h"
Include dependency graph for transport_api2_monitor.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_TRANSPORT_MonitorContext
 Opaque handle to the transport service for monitors. More...
 

Functions

static void reconnect (struct GNUNET_TRANSPORT_MonitorContext *mc)
 (re)connect our monitor to the transport service More...
 
static void send_start_monitor (struct GNUNET_TRANSPORT_MonitorContext *mc)
 Send message to the transport service about our montoring desire. More...
 
static void disconnect (struct GNUNET_TRANSPORT_MonitorContext *mc)
 Disconnect from the transport service. More...
 
static void error_handler (void *cls, enum GNUNET_MQ_Error error)
 Function called on MQ errors. More...
 
static int check_monitor_data (void *cls, const struct GNUNET_TRANSPORT_MonitorData *md)
 Transport service sends us information about what is going on. More...
 
static void handle_monitor_data (void *cls, const struct GNUNET_TRANSPORT_MonitorData *md)
 Transport service sends us information about what is going on. More...
 
static void handle_monitor_end (void *cls, const struct GNUNET_MessageHeader *me)
 One shot was requested, and transport service is done. More...
 
struct GNUNET_TRANSPORT_MonitorContextGNUNET_TRANSPORT_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_PeerIdentity *peer, int one_shot, GNUNET_TRANSPORT_MonitorCallback cb, void *cb_cls)
 Return information about a specific peer or all peers currently known to transport service once or in monitoring mode. More...
 
void GNUNET_TRANSPORT_monitor_cancel (struct GNUNET_TRANSPORT_MonitorContext *mc)
 Cancel request to monitor peers. More...
 

Detailed Description

implementation of the gnunet_transport_monitor_service.h API

Author
Christian Grothoff

Definition in file transport_api2_monitor.c.

Function Documentation

◆ reconnect()

static void reconnect ( struct GNUNET_TRANSPORT_MonitorContext mc)
static

(re)connect our monitor to the transport service

Parameters
mchandle to reconnect

Definition at line 206 of file transport_api2_monitor.c.

207{
209 { GNUNET_MQ_hd_var_size (monitor_data,
212 mc),
213 GNUNET_MQ_hd_fixed_size (monitor_end,
216 mc),
218
219 mc->mq =
220 GNUNET_CLIENT_connect (mc->cfg, "transport", handlers, &error_handler, mc);
221 if (NULL == mc->mq)
222 return;
224}
struct GNUNET_MQ_MessageHandlers handlers[]
Definition: 003.c:1
static struct GNUNET_TESTBED_Controller * mc
Handle to the master controller.
struct GNUNET_MQ_Handle * GNUNET_CLIENT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *error_handler_cls)
Create a message queue to connect to a GNUnet service.
Definition: client.c:1057
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_DATA
Message sent to indicate to a monitor about events.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_END
Message sent to indicate to a monitor that a one-shot iteration over events is done.
Message handler for a specific message type.
Header for all communications.
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
Function called on MQ errors.
static void send_start_monitor(struct GNUNET_TRANSPORT_MonitorContext *mc)
Send message to the transport service about our montoring desire.

References error_handler(), GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_DATA, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_END, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, handlers, mc, and send_start_monitor().

Referenced by error_handler(), GNUNET_TRANSPORT_monitor(), and handle_monitor_end().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ send_start_monitor()

static void send_start_monitor ( struct GNUNET_TRANSPORT_MonitorContext mc)
static

Send message to the transport service about our montoring desire.

Parameters
aiaddress to delete

Definition at line 86 of file transport_api2_monitor.c.

87{
88 struct GNUNET_MQ_Envelope *env;
90
91 if (NULL == mc->mq)
92 return;
94 smm->one_shot = htonl ((uint32_t) mc->one_shot);
95 smm->peer = mc->peer;
96 GNUNET_MQ_send (mc->mq, env);
97}
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
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:304
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:78
#define GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_START
Message sent to indicate to the transport that a monitor wants to observe certain events.
Request to start monitoring.
Definition: transport.h:676
uint32_t one_shot
GNUNET_YES for one-shot montoring, GNUNET_NO for continuous monitoring.
Definition: transport.h:685
struct GNUNET_PeerIdentity peer
Target identifier to monitor, all zeros for "all peers".
Definition: transport.h:690

References env, GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_START, GNUNET_MQ_msg, GNUNET_MQ_send(), mc, GNUNET_TRANSPORT_MonitorStart::one_shot, and GNUNET_TRANSPORT_MonitorStart::peer.

Referenced by reconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ disconnect()

static void disconnect ( struct GNUNET_TRANSPORT_MonitorContext mc)
static

Disconnect from the transport service.

Parameters
mcservice to disconnect from

Definition at line 106 of file transport_api2_monitor.c.

107{
108 if (NULL == mc->mq)
109 return;
110 GNUNET_MQ_destroy (mc->mq);
111 mc->mq = NULL;
112}
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:683

References GNUNET_MQ_destroy(), and mc.

Referenced by error_handler(), GNUNET_TRANSPORT_monitor_cancel(), and handle_monitor_end().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ error_handler()

static void error_handler ( void *  cls,
enum GNUNET_MQ_Error  error 
)
static

Function called on MQ errors.

Reconnects to the service.

Parameters
clsour struct GNUNET_TRANSPORT_MonitorContext *
errorwhat error happened?

Definition at line 122 of file transport_api2_monitor.c.

123{
125
127 "MQ failure %d, reconnecting to transport service.\n",
128 error);
129 disconnect (mc);
130 /* TODO: maybe do this with exponential backoff/delay */
131 reconnect (mc);
132}
#define GNUNET_log(kind,...)
@ GNUNET_ERROR_TYPE_INFO
Opaque handle to the transport service for monitors.
static void disconnect(struct GNUNET_TRANSPORT_MonitorContext *mc)
Disconnect from the transport service.
static void reconnect(struct GNUNET_TRANSPORT_MonitorContext *mc)
(re)connect our monitor to the transport service

References disconnect(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, mc, and reconnect().

Referenced by reconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_monitor_data()

static int check_monitor_data ( void *  cls,
const struct GNUNET_TRANSPORT_MonitorData md 
)
static

Transport service sends us information about what is going on.

Check if md is well-formed.

Parameters
clsour struct GNUNET_TRANSPORT_MonitorContext *
mdthe monitor data we got
Returns
GNUNET_OK if smt is well-formed

Definition at line 144 of file transport_api2_monitor.c.

145{
146 (void) cls;
148 return GNUNET_OK;
149}
@ GNUNET_OK
#define GNUNET_MQ_check_zero_termination(m)
Insert code for a "check_" function that verifies that a given variable-length message received over ...

References GNUNET_MQ_check_zero_termination, and GNUNET_OK.

◆ handle_monitor_data()

static void handle_monitor_data ( void *  cls,
const struct GNUNET_TRANSPORT_MonitorData md 
)
static

Transport service sends us information about what is going on.

Parameters
clsour struct GNUNET_TRANSPORT_MonitorContext *
mdmonitor data

Definition at line 159 of file transport_api2_monitor.c.

160{
163
164 mi.address = (const char *) &md[1];
165 mi.nt = (enum GNUNET_NetworkType) ntohl (md->nt);
166 mi.cs = (enum GNUNET_TRANSPORT_ConnectionStatus) ntohl (md->cs);
167 mi.num_msg_pending = ntohl (md->num_msg_pending);
168 mi.num_bytes_pending = ntohl (md->num_bytes_pending);
169 mi.last_validation = GNUNET_TIME_absolute_ntoh (md->last_validation);
170 mi.valid_until = GNUNET_TIME_absolute_ntoh (md->valid_until);
171 mi.next_validation = GNUNET_TIME_absolute_ntoh (md->next_validation);
172 mi.rtt = GNUNET_TIME_relative_ntoh (md->rtt);
173 mc->cb (mc->cb_cls, &md->peer, &mi);
174}
GNUNET_TRANSPORT_ConnectionStatus
Possible states of a connection.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:44
struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh(struct GNUNET_TIME_RelativeNBO a)
Convert relative time from network byte order.
Definition: time.c:628
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh(struct GNUNET_TIME_AbsoluteNBO a)
Convert absolute time from network byte order.
Definition: time.c:737
uint32_t num_msg_pending
Messages pending (in NBO).
Definition: transport.h:734
struct GNUNET_PeerIdentity peer
Target identifier.
Definition: transport.h:712
struct GNUNET_TIME_AbsoluteNBO valid_until
Definition: transport.h:718
struct GNUNET_TIME_AbsoluteNBO last_validation
Definition: transport.h:717
uint32_t num_bytes_pending
Bytes pending (in NBO).
Definition: transport.h:739
struct GNUNET_TIME_AbsoluteNBO next_validation
Definition: transport.h:719
uint32_t nt
Network type (an enum GNUNET_NetworkType in NBO).
Definition: transport.h:707
struct GNUNET_TIME_RelativeNBO rtt
Current round-trip time estimate.
Definition: transport.h:724
uint32_t cs
Connection status (in NBO).
Definition: transport.h:729
Information about another peer's address.
const char * address
Address we have for the peer, human-readable, 0-terminated, in UTF-8.

References GNUNET_TRANSPORT_MonitorInformation::address, GNUNET_TRANSPORT_MonitorInformation::cs, GNUNET_TRANSPORT_MonitorData::cs, GNUNET_TIME_absolute_ntoh(), GNUNET_TIME_relative_ntoh(), GNUNET_TRANSPORT_MonitorInformation::last_validation, GNUNET_TRANSPORT_MonitorData::last_validation, mc, GNUNET_TRANSPORT_MonitorInformation::next_validation, GNUNET_TRANSPORT_MonitorData::next_validation, GNUNET_TRANSPORT_MonitorInformation::nt, GNUNET_TRANSPORT_MonitorData::nt, GNUNET_TRANSPORT_MonitorInformation::num_bytes_pending, GNUNET_TRANSPORT_MonitorData::num_bytes_pending, GNUNET_TRANSPORT_MonitorInformation::num_msg_pending, GNUNET_TRANSPORT_MonitorData::num_msg_pending, GNUNET_TRANSPORT_MonitorData::peer, GNUNET_TRANSPORT_MonitorInformation::rtt, GNUNET_TRANSPORT_MonitorData::rtt, GNUNET_TRANSPORT_MonitorInformation::valid_until, and GNUNET_TRANSPORT_MonitorData::valid_until.

Here is the call graph for this function:

◆ handle_monitor_end()

static void handle_monitor_end ( void *  cls,
const struct GNUNET_MessageHeader me 
)
static

One shot was requested, and transport service is done.

Parameters
clsour struct GNUNET_TRANSPORT_MonitorContext *
meend message

Definition at line 184 of file transport_api2_monitor.c.

185{
187
188 if (GNUNET_YES != mc->one_shot)
189 {
190 GNUNET_break (0);
191 disconnect (mc);
192 reconnect (mc);
193 return;
194 }
195 mc->cb (mc->cb_cls, NULL, NULL);
197}
void GNUNET_TRANSPORT_monitor_cancel(struct GNUNET_TRANSPORT_MonitorContext *mc)
Cancel request to monitor peers.
@ GNUNET_YES
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.

References disconnect(), GNUNET_break, GNUNET_TRANSPORT_monitor_cancel(), GNUNET_YES, mc, and reconnect().

Here is the call graph for this function: