GNUnet  0.10.x
Data Structures | Macros | Enumerations | Functions
plugin_transport_http_client.c File Reference

HTTP/S client transport plugin. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_transport_plugin.h"
#include "plugin_transport_http_common.h"
#include "gnunet_curl_lib.h"
Include dependency graph for plugin_transport_http_client.c:

Go to the source code of this file.

Data Structures

struct  HTTP_Message
 Message to send using http. More...
 
struct  RequestHandle
 The request handle. More...
 
struct  GNUNET_ATS_Session
 Information about ongoing sessions of the transport client. More...
 
struct  HTTP_Client_Plugin
 Encapsulation of all of the state of the plugin. More...
 
struct  GNUNET_ATS_SessionClientCtx
 Closure for session_lookup_client_by_address(). More...
 

Macros

#define PLUGIN_NAME   "http_client"
 
#define HTTP_STAT_STR_CONNECTIONS   "# HTTP client connections"
 
#define LIBGNUNET_PLUGIN_TRANSPORT_INIT   libgnunet_plugin_transport_http_client_init
 
#define LIBGNUNET_PLUGIN_TRANSPORT_DONE   libgnunet_plugin_transport_http_client_done
 
#define VERBOSE_CURL   GNUNET_NO
 
#define PUT_DISCONNECT_TIMEOUT   GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 1)
 
#define ENABLE_PUT   GNUNET_YES
 
#define ENABLE_GET   GNUNET_YES
 
#define LOG(kind, ...)   GNUNET_log_from(kind, PLUGIN_NAME, __VA_ARGS__)
 

Enumerations

enum  HTTP_PUT_REQUEST_STATE {
  H_NOT_CONNECTED, H_CONNECTED, H_PAUSED, H_TMP_DISCONNECTING,
  H_TMP_RECONNECT_REQUIRED, H_TMP_DISCONNECTED, H_DISCONNECTED
}
 State of a HTTP PUT request. More...
 

Functions

static int http_client_plugin_session_disconnect (void *cls, struct GNUNET_ATS_Session *s)
 Disconnect a session. More...
 
static void notify_session_monitor (struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
 If a session monitor is attached, notify it about the new session state. More...
 
static void client_delete_session (struct GNUNET_ATS_Session *s)
 Delete session s. More...
 
static void client_reschedule_session_timeout (struct GNUNET_ATS_Session *s)
 Increment session timeout due to activity for session s. More...
 
static void client_run (void *cls)
 Task performing curl operations. More...
 
static int client_schedule (struct HTTP_Client_Plugin *plugin, int now)
 Function setting up file descriptors and scheduling task to run. More...
 
static int client_connect_get (struct GNUNET_ATS_Session *s)
 Connect GET request. More...
 
static int client_connect_put (struct GNUNET_ATS_Session *s)
 Connect a HTTP put request. More...
 
static ssize_t http_client_plugin_send (void *cls, struct GNUNET_ATS_Session *s, const char *msgbuf, size_t msgbuf_size, unsigned int priority, struct GNUNET_TIME_Relative to, GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 Function that can be used by the transport service to transmit a message using the plugin. More...
 
static unsigned int http_client_query_keepalive_factor (void *cls)
 Function that is called to get the keepalive factor. More...
 
static int destroy_session_cb (void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
 Callback to destroys all sessions on exit. More...
 
static void http_client_plugin_peer_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 Function that can be used to force the plugin to disconnect from the given peer and cancel all previous transmissions (and their continuationc). More...
 
static int session_lookup_client_by_address (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 Locate the seession object for a given address. More...
 
static struct GNUNET_ATS_Sessionclient_lookup_session (struct HTTP_Client_Plugin *plugin, const struct GNUNET_HELLO_Address *address)
 Check if a sessions exists for an specific address. More...
 
static void client_put_disconnect (void *cls)
 When we have nothing to transmit, we pause the HTTP PUT after a while (so that gnurl stops asking). More...
 
static size_t client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
 Callback method used with libcurl Method is called when libcurl needs to read data during sending. More...
 
static void client_wake_up (void *cls)
 Wake up a curl handle which was suspended. More...
 
static int client_receive_mst_cb (void *cls, const struct GNUNET_MessageHeader *message)
 Callback for message stream tokenizer. More...
 
static size_t client_receive_put (void *stream, size_t size, size_t nmemb, void *cls)
 Callback method used with libcurl when data for a PUT request are received. More...
 
static size_t client_receive (void *stream, size_t size, size_t nmemb, void *cls)
 Callback method used with libcurl when data for a GET request are received. More...
 
static int client_connect (struct GNUNET_ATS_Session *s)
 Connect both PUT and GET request for a session. More...
 
static enum GNUNET_NetworkType http_client_plugin_get_network (void *cls, struct GNUNET_ATS_Session *session)
 Function obtain the network type for a session. More...
 
static enum GNUNET_NetworkType http_client_plugin_get_network_for_address (void *cls, const struct GNUNET_HELLO_Address *address)
 Function obtain the network type for an address. More...
 
static void client_session_timeout (void *cls)
 Session was idle, so disconnect it. More...
 
static struct GNUNET_ATS_Sessionhttp_client_plugin_get_session (void *cls, const struct GNUNET_HELLO_Address *address)
 Creates a new outbound session the transport service will use to send data to the peer. More...
 
static int client_start (struct HTTP_Client_Plugin *plugin)
 Setup http_client plugin. More...
 
static int http_client_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
 Another peer has suggested an address for this peer and transport plugin. More...
 
void * libgnunet_plugin_transport_http_client_done (void *cls)
 Exit point from the plugin. More...
 
static int client_configure_plugin (struct HTTP_Client_Plugin *plugin)
 Configure plugin. More...
 
static const char * http_client_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
 Function to convert an address to a human-readable string. More...
 
static void http_client_plugin_update_session_timeout (void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_ATS_Session *session)
 Function that will be called whenever the transport service wants to notify the plugin that a session is still active and in use and therefore the session timeout for this session has to be updated. More...
 
static void http_client_plugin_update_inbound_delay (void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_ATS_Session *s, struct GNUNET_TIME_Relative delay)
 Function that will be called whenever the transport service wants to notify the plugin that the inbound quota changed and that the plugin should update it's delay for the next receive value. More...
 
static int send_session_info_iter (void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
 Return information about the given session to the monitor callback. More...
 
static void http_client_plugin_setup_monitor (void *cls, GNUNET_TRANSPORT_SessionInfoCallback sic, void *sic_cls)
 Begin monitoring sessions of a plugin. More...
 
void * libgnunet_plugin_transport_http_client_init (void *cls)
 Entry point for the plugin. More...
 

Detailed Description

HTTP/S client transport plugin.

Author
Matthias Wachs
Christian Grothoff

Definition in file plugin_transport_http_client.c.

Macro Definition Documentation

◆ PLUGIN_NAME

#define PLUGIN_NAME   "http_client"

◆ HTTP_STAT_STR_CONNECTIONS

#define HTTP_STAT_STR_CONNECTIONS   "# HTTP client connections"

◆ LIBGNUNET_PLUGIN_TRANSPORT_INIT

#define LIBGNUNET_PLUGIN_TRANSPORT_INIT   libgnunet_plugin_transport_http_client_init

Definition at line 36 of file plugin_transport_http_client.c.

◆ LIBGNUNET_PLUGIN_TRANSPORT_DONE

#define LIBGNUNET_PLUGIN_TRANSPORT_DONE   libgnunet_plugin_transport_http_client_done

◆ VERBOSE_CURL

#define VERBOSE_CURL   GNUNET_NO

Definition at line 40 of file plugin_transport_http_client.c.

◆ PUT_DISCONNECT_TIMEOUT

#define PUT_DISCONNECT_TIMEOUT   GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 1)

Definition at line 42 of file plugin_transport_http_client.c.

Referenced by client_send_cb().

◆ ENABLE_PUT

#define ENABLE_PUT   GNUNET_YES

Definition at line 44 of file plugin_transport_http_client.c.

◆ ENABLE_GET

#define ENABLE_GET   GNUNET_YES

Definition at line 45 of file plugin_transport_http_client.c.

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from(kind, PLUGIN_NAME, __VA_ARGS__)

Enumeration Type Documentation

◆ HTTP_PUT_REQUEST_STATE

State of a HTTP PUT request.

Enumerator
H_NOT_CONNECTED 

Just created, not yet connected.

H_CONNECTED 

Connected.

H_PAUSED 

Paused, nothing to send.

H_TMP_DISCONNECTING 

Temporary disconnect in progress due to inactivity.

H_TMP_RECONNECT_REQUIRED 

Send request while temporary disconnect, reconnect.

H_TMP_DISCONNECTED 

Temporarily disconnected.

H_DISCONNECTED 

Disconnected.

Definition at line 66 of file plugin_transport_http_client.c.

66  {
71 
76 
80  H_PAUSED,
81 
86 
91 
96 
101 };
Paused, nothing to send.
Temporarily disconnected.
Just created, not yet connected.
Temporary disconnect in progress due to inactivity.
Send request while temporary disconnect, reconnect.

Function Documentation

◆ http_client_plugin_session_disconnect()

static int http_client_plugin_session_disconnect ( void *  cls,
struct GNUNET_ATS_Session s 
)
static

Disconnect a session.

Parameters
clsthe struct HTTP_Client_Plugin *
ssession
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 837 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, client_delete_session(), HTTP_Client_Plugin::client_perform_task, client_schedule(), GNUNET_TRANSPORT_PluginEnvironment::cls, HTTP_Client_Plugin::env, GNUNET_ERROR_TYPE_DEBUG, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_YES, LOG, plugin, and GNUNET_TRANSPORT_PluginEnvironment::session_end.

Referenced by client_run(), client_session_timeout(), destroy_session_cb(), http_client_plugin_send(), and libgnunet_plugin_transport_http_client_init().

839 {
840  struct HTTP_Client_Plugin *plugin = cls;
841 
843  "Session %p: notifying transport about ending session\n",
844  s);
845  plugin->env->session_end(plugin->env->cls,
846  s->address,
847  s);
849 
850  /* Re-schedule since handles have changed */
851  if (NULL != plugin->client_perform_task)
852  {
854  plugin->client_perform_task = NULL;
855  }
856  client_schedule(plugin, GNUNET_YES);
857 
858  return GNUNET_OK;
859 }
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
GNUNET_TRANSPORT_SessionEnd session_end
Function that must be called by the plugin when a non-NULL session handle stops being valid (is destr...
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void * cls
Closure for the various callbacks.
static int client_schedule(struct HTTP_Client_Plugin *plugin, int now)
Function setting up file descriptors and scheduling task to run.
Encapsulation of all of the state of the plugin.
struct GNUNET_SCHEDULER_Task * client_perform_task
curl perform task
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
static void client_delete_session(struct GNUNET_ATS_Session *s)
Delete session s.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ notify_session_monitor()

static void notify_session_monitor ( struct HTTP_Client_Plugin plugin,
struct GNUNET_ATS_Session session,
enum GNUNET_TRANSPORT_SessionState  state 
)
static

If a session monitor is attached, notify it about the new session state.

Parameters
pluginour plugin
sessionsession that changed state
statenew state of the session

Definition at line 403 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, GNUNET_TRANSPORT_SessionInfo::address, GNUNET_ATS_Session::bytes_in_queue, GNUNET_NO, GNUNET_TRANSPORT_SessionInfo::is_inbound, GNUNET_ATS_Session::msgs_in_queue, GNUNET_ATS_Session::next_receive, GNUNET_TRANSPORT_SessionInfo::num_bytes_pending, GNUNET_TRANSPORT_SessionInfo::num_msg_pending, GNUNET_TRANSPORT_SessionInfo::receive_delay, GNUNET_TRANSPORT_SessionInfo::session_timeout, HTTP_Client_Plugin::sic, HTTP_Client_Plugin::sic_cls, state, GNUNET_TRANSPORT_SessionInfo::state, and GNUNET_ATS_Session::timeout.

Referenced by client_delete_session(), client_send_cb(), client_session_timeout(), http_client_plugin_get_session(), http_client_plugin_send(), send_session_info_iter(), and template_plugin_update_session_timeout().

406 {
407  struct GNUNET_TRANSPORT_SessionInfo info;
408 
409  if (NULL == plugin->sic)
410  return;
411  memset(&info, 0, sizeof(info));
412  info.state = state;
413  info.is_inbound = GNUNET_NO;
414  info.num_msg_pending = session->msgs_in_queue;
415  info.num_bytes_pending = session->bytes_in_queue;
416  info.receive_delay = session->next_receive;
417  info.session_timeout = session->timeout;
418  info.address = session->address;
419  plugin->sic(plugin->sic_cls,
420  session,
421  &info);
422 }
unsigned int msgs_in_queue
Number of messages waiting for transmission to this peer.
struct GNUNET_TIME_Absolute timeout
When does this session time out.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_HELLO_Address * address
Address.
unsigned long long bytes_in_queue
Number of bytes waiting for transmission to this peer.
struct GNUNET_TIME_Absolute next_receive
Absolute time when to receive data again Used for receive throttling.
Information about a plugin's session.
enum State state
current state of profiling
GNUNET_TRANSPORT_SessionInfoCallback sic
Function to call about session status changes.
void * sic_cls
Closure for sic.
Here is the caller graph for this function:

◆ client_delete_session()

static void client_delete_session ( struct GNUNET_ATS_Session s)
static

Delete session s.

Parameters
sthe session to delete

Definition at line 431 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, GNUNET_ATS_Session::bytes_in_queue, HTTP_Client_Plugin::cur_requests, HTTP_Client_Plugin::curl_multi_handle, RequestHandle::easyhandle, HTTP_Client_Plugin::env, GNUNET_ATS_Session::get, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multipeermap_remove(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_HELLO_address_free, GNUNET_i2s(), GNUNET_MST_destroy(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_set(), GNUNET_SYSERR, GNUNET_TIME_UNIT_ZERO_ABS, GNUNET_TRANSPORT_SS_DONE, HTTP_STAT_STR_CONNECTIONS, LOG, GNUNET_ATS_Session::msg_head, GNUNET_ATS_Session::msg_tail, GNUNET_ATS_Session::msg_tk, GNUNET_ATS_Session::msgs_in_queue, HTTP_Message::next, notify_session_monitor(), GNUNET_ATS_Session::overhead, GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, HTTP_Message::pos, GNUNET_ATS_Session::put, GNUNET_ATS_Session::put_disconnect_task, GNUNET_ATS_Session::recv_wakeup_task, HTTP_Client_Plugin::sessions, HTTP_Message::size, GNUNET_TRANSPORT_PluginEnvironment::stats, GNUNET_ATS_Session::timeout, GNUNET_ATS_Session::timeout_task, HTTP_Message::transmit_cont, HTTP_Message::transmit_cont_cls, and GNUNET_ATS_Session::url.

Referenced by http_client_plugin_get_session(), and http_client_plugin_session_disconnect().

432 {
433  struct HTTP_Client_Plugin *plugin = s->plugin;
434  struct HTTP_Message *pos;
435  struct HTTP_Message *next;
436  CURLMcode mret;
437 
438  if (NULL != s->timeout_task)
439  {
441  s->timeout_task = NULL;
443  }
444  if (NULL != s->put_disconnect_task)
445  {
447  s->put_disconnect_task = NULL;
448  }
449  if (NULL != s->recv_wakeup_task)
450  {
452  s->recv_wakeup_task = NULL;
453  }
456  &s->address->peer,
457  s));
458  if (NULL != s->put.easyhandle)
459  {
461  "Session %p/request %p: disconnecting PUT request to peer `%s'\n",
462  s,
463  s->put.easyhandle,
464  GNUNET_i2s(&s->address->peer));
465 
466  /* remove curl handle from multi handle */
467  mret = curl_multi_remove_handle(plugin->curl_multi_handle,
468  s->put.easyhandle);
469  GNUNET_break(CURLM_OK == mret);
470  curl_easy_cleanup(s->put.easyhandle);
471  GNUNET_assert(plugin->cur_requests > 0);
472  plugin->cur_requests--;
473  s->put.easyhandle = NULL;
474  }
475  if (NULL != s->get.easyhandle)
476  {
478  "Session %p/request %p: disconnecting GET request to peer `%s'\n",
479  s, s->get.easyhandle,
480  GNUNET_i2s(&s->address->peer));
481  /* remove curl handle from multi handle */
482  mret = curl_multi_remove_handle(plugin->curl_multi_handle,
483  s->get.easyhandle);
484  GNUNET_break(CURLM_OK == mret);
485  curl_easy_cleanup(s->get.easyhandle);
486  GNUNET_assert(plugin->cur_requests > 0);
487  plugin->cur_requests--;
488  s->get.easyhandle = NULL;
489  }
490 
493  plugin->cur_requests,
494  GNUNET_NO);
495  next = s->msg_head;
496  while (NULL != (pos = next))
497  {
498  next = pos->next;
500  s->msg_tail,
501  pos);
503  s->msgs_in_queue--;
504  GNUNET_assert(pos->size <= s->bytes_in_queue);
505  s->bytes_in_queue -= pos->size;
506  if (NULL != pos->transmit_cont)
508  &s->address->peer,
510  pos->size,
511  pos->pos + s->overhead);
512  s->overhead = 0;
513  GNUNET_free(pos);
514  }
515  GNUNET_assert(0 == s->msgs_in_queue);
516  GNUNET_assert(0 == s->bytes_in_queue);
517  notify_session_monitor(plugin,
518  s,
520  if (NULL != s->msg_tk)
521  {
523  s->msg_tk = NULL;
524  }
526  GNUNET_free(s->url);
527  GNUNET_free(s);
528 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
Session is being torn down and about to disappear.
#define GNUNET_TIME_UNIT_ZERO_ABS
Absolute time zero.
struct GNUNET_SCHEDULER_Task * recv_wakeup_task
Task to wake up client receive handle when receiving is allowed again.
unsigned int msgs_in_queue
Number of messages waiting for transmission to this peer.
struct GNUNET_SCHEDULER_Task * timeout_task
Session timeout task.
struct HTTP_Message * msg_tail
previous pointer for double linked list
struct Plugin * plugin
Pointer to the global plugin struct.
size_t pos
amount of data already sent
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
Message to send using http.
struct GNUNET_SERVER_MessageStreamTokenizer * msg_tk
Message stream tokenizer for incoming data.
struct HTTP_Message * next
next pointer for double linked list
struct GNUNET_TIME_Absolute timeout
When does this session time out.
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct RequestHandle get
Handle for the HTTP GET request.
struct HTTP_Message * msg_head
next pointer for double linked list
struct GNUNET_SCHEDULER_Task * put_disconnect_task
Session timeout task.
unsigned long long bytes_in_queue
Number of bytes waiting for transmission to this peer.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void * transmit_cont_cls
Closure for transmit_cont.
GNUNET_TRANSPORT_TransmitContinuation transmit_cont
Continuation function to call once the transmission buffer has again space available.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
void GNUNET_MST_destroy(struct GNUNET_MessageStreamTokenizer *mst)
Destroys a tokenizer.
Definition: mst.c:410
void GNUNET_STATISTICS_set(struct GNUNET_STATISTICS_Handle *handle, const char *name, uint64_t value, int make_persistent)
Set statistic value for the peer.
size_t size
buffer length
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
char * url
The URL to connect to.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Encapsulation of all of the state of the plugin.
unsigned int cur_requests
Current number of sockets the plugin can use Each http connections are two requests.
#define HTTP_STAT_STR_CONNECTIONS
CURLM * curl_multi_handle
cURL Multihandle
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
size_t overhead
Outbound overhead due to HTTP connection Add to next message of this session when calling callback...
#define LOG(kind,...)
CURL * easyhandle
The curl easy handle.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_HELLO_address_free(addr)
Free an address.
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_reschedule_session_timeout()

static void client_reschedule_session_timeout ( struct GNUNET_ATS_Session s)
static

Increment session timeout due to activity for session s.

Parameters
sthe session

Definition at line 537 of file plugin_transport_http_client.c.

References client_run(), GNUNET_assert, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, GNUNET_TIME_relative_to_absolute(), GNUNET_ATS_Session::timeout, and GNUNET_ATS_Session::timeout_task.

Referenced by client_receive_mst_cb(), and http_client_plugin_update_session_timeout().

538 {
539  GNUNET_assert(NULL != s->timeout_task);
541 }
struct GNUNET_SCHEDULER_Task * timeout_task
Session timeout task.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_TIME_Absolute timeout
When does this session time out.
#define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
After how long do we consider a connection to a peer dead if we don&#39;t receive messages from the peer...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_run()

static void client_run ( void *  cls)
static

Task performing curl operations.

Parameters
clsplugin as closure
tcgnunet scheduler task context
clsplugin as closure

Definition at line 1285 of file plugin_transport_http_client.c.

References _, GNUNET_ATS_Session::address, address, client_connect_get(), client_connect_put(), HTTP_Client_Plugin::client_perform_task, client_schedule(), HTTP_Client_Plugin::cur_requests, HTTP_Client_Plugin::curl_multi_handle, RequestHandle::easyhandle, HTTP_Client_Plugin::emulate_xhr, HTTP_Client_Plugin::env, GNUNET_ATS_Session::get, GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_i2s(), GNUNET_log, GNUNET_NO, GNUNET_STATISTICS_set(), GNUNET_SYSERR, GNUNET_YES, H_CONNECTED, H_DISCONNECTED, H_NOT_CONNECTED, H_PAUSED, H_TMP_DISCONNECTED, H_TMP_DISCONNECTING, H_TMP_RECONNECT_REQUIRED, http_client_plugin_session_disconnect(), HTTP_STAT_STR_CONNECTIONS, LOG, msg, GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::put, ret, RequestHandle::s, RequestHandle::state, GNUNET_TRANSPORT_PluginEnvironment::stats, and GNUNET_ATS_Session::url.

Referenced by client_connect(), client_reschedule_session_timeout(), and client_schedule().

1286 {
1287  struct HTTP_Client_Plugin *plugin = cls;
1288  int running;
1289  long http_statuscode;
1290  CURLMcode mret;
1291  CURLMsg *msg;
1292  int put_request; /* GNUNET_YES if easy handle is put, GNUNET_NO for get */
1293  int msgs_left;
1294 
1295  plugin->client_perform_task = NULL;
1296  /* While data are available or timeouts occured */
1297  do
1298  {
1299  running = 0;
1300  /* Perform operations for all handles */
1301  mret = curl_multi_perform(plugin->curl_multi_handle, &running);
1302 
1303  /* Get additional information for all handles */
1304  while (NULL != (msg = curl_multi_info_read(plugin->curl_multi_handle, &msgs_left)))
1305  {
1306  CURL *easy_h = msg->easy_handle;
1307  struct GNUNET_ATS_Session *s = NULL;
1308  char *d = NULL; /* curl requires 'd' to be a 'char *' */
1309 
1310  GNUNET_assert(NULL != easy_h);
1311 
1312  /* Obtain session from easy handle */
1313  GNUNET_assert(CURLE_OK == curl_easy_getinfo(easy_h, CURLINFO_PRIVATE, &d));
1314  s = (struct GNUNET_ATS_Session *)d;
1315  GNUNET_assert(NULL != s);
1316 
1317  if (msg->msg != CURLMSG_DONE)
1318  continue; /* This should not happen */
1319 
1320  /* Get HTTP response code */
1321  GNUNET_break(CURLE_OK == curl_easy_getinfo(easy_h,
1322  CURLINFO_RESPONSE_CODE, &http_statuscode));
1323 
1324  if (easy_h == s->put.easyhandle)
1325  put_request = GNUNET_YES;
1326  else
1327  put_request = GNUNET_NO;
1328 
1329  /* Log status of terminated request */
1330  if ((0 != msg->data.result) || (http_statuscode != 200))
1332  "Session %p/request %p: %s request to `%s' ended with status %i reason %i: `%s'\n",
1333  s, msg->easy_handle,
1334  (GNUNET_YES == put_request) ? "PUT" : "GET",
1335  GNUNET_i2s(&s->address->peer),
1336  http_statuscode,
1337  msg->data.result,
1338  curl_easy_strerror(msg->data.result));
1339  else
1341  "Session %p/request %p: %s request to `%s' ended normal\n",
1342  s, msg->easy_handle,
1343  (GNUNET_YES == put_request) ? "PUT" : "GET",
1344  GNUNET_i2s(&s->address->peer));
1345 
1346  /* Remove easy handle from multi handle */
1347  curl_multi_remove_handle(plugin->curl_multi_handle, easy_h);
1348 
1349  /* Clean up easy handle */
1350  curl_easy_cleanup(easy_h);
1351 
1352  /* Remove information */
1353  GNUNET_assert(plugin->cur_requests > 0);
1354  plugin->cur_requests--;
1356  "%s request to %s done, number of requests decreased to %u\n",
1357  (GNUNET_YES == put_request) ? "PUT" : "GET",
1358  s->url,
1359  plugin->cur_requests);
1360 
1361  if (GNUNET_YES == put_request)
1362  {
1363  /* Clean up a PUT request */
1364  s->put.easyhandle = NULL;
1365  s->put.s = NULL;
1366 
1367  switch (s->put.state)
1368  {
1369  case H_NOT_CONNECTED:
1370  case H_DISCONNECTED:
1371  case H_TMP_DISCONNECTED:
1372  /* This must not happen */
1373  GNUNET_break(0);
1374  break;
1375 
1377  /* Transport called send while disconnect in progess, reconnect */
1379  {
1380  /* Reconnect failed, disconnect session */
1382  }
1383  break;
1384 
1385  case H_TMP_DISCONNECTING:
1386  /* PUT gets temporarily disconnected */
1388  break;
1389 
1390  case H_PAUSED:
1391  case H_CONNECTED:
1392  /* PUT gets permanently disconnected */
1393  s->put.state = H_DISCONNECTED;
1395  break;
1396 
1397  default:
1398  GNUNET_break(0);
1399  break;
1400  }
1401  }
1402  else if (GNUNET_NO == put_request)
1403  {
1404  /* Clean up a GET request */
1405  s->get.easyhandle = NULL;
1406  s->get.s = NULL;
1407 
1408  /* If we are emulating an XHR client we need to make another GET
1409  * request.
1410  */
1411  if (GNUNET_YES == plugin->emulate_xhr)
1412  {
1415  }
1416  else
1417  {
1418  /* GET request was terminated, so disconnect session */
1420  }
1421  }
1422  else
1423  GNUNET_break(0); /* Must not happen */
1424 
1425  GNUNET_STATISTICS_set(plugin->env->stats,
1427  plugin->cur_requests,
1428  GNUNET_NO);
1429  }
1430  }
1431  while (mret == CURLM_CALL_MULTI_PERFORM);
1432  client_schedule(plugin, GNUNET_NO);
1433 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static int http_client_plugin_session_disconnect(void *cls, struct GNUNET_ATS_Session *s)
Disconnect a session.
static int client_connect_get(struct GNUNET_ATS_Session *s)
Connect GET request.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct RequestHandle get
Handle for the HTTP GET request.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
Paused, nothing to send.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
Temporarily disconnected.
static int client_schedule(struct HTTP_Client_Plugin *plugin, int now)
Function setting up file descriptors and scheduling task to run.
Information about ongoing sessions of the transport client.
void GNUNET_STATISTICS_set(struct GNUNET_STATISTICS_Handle *handle, const char *name, uint64_t value, int make_persistent)
Set statistic value for the peer.
static int client_connect_put(struct GNUNET_ATS_Session *s)
Connect a HTTP put request.
int state
The processing state.
char * url
The URL to connect to.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
int emulate_xhr
Should we emulate an XHR client for testing?
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Just created, not yet connected.
Encapsulation of all of the state of the plugin.
struct GNUNET_SCHEDULER_Task * client_perform_task
curl perform task
unsigned int cur_requests
Current number of sockets the plugin can use Each http connections are two requests.
#define HTTP_STAT_STR_CONNECTIONS
CURLM * curl_multi_handle
cURL Multihandle
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
Temporary disconnect in progress due to inactivity.
struct GNUNET_ATS_Session * s
The related session.
CURL * easyhandle
The curl easy handle.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Send request while temporary disconnect, reconnect.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_schedule()

static int client_schedule ( struct HTTP_Client_Plugin plugin,
int  now 
)
static

Function setting up file descriptors and scheduling task to run.

Parameters
pluginthe plugin as closure
nowschedule task in 1ms, regardless of what curl may say
Returns
GNUNET_SYSERR for hard failure, GNUNET_OK for ok

Definition at line 562 of file plugin_transport_http_client.c.

References _, ch, client_connect_get(), client_connect_put(), HTTP_Client_Plugin::client_perform_task, client_run(), curl, HTTP_Client_Plugin::curl_multi_handle, data, RequestHandle::easyhandle, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_memcpy, GNUNET_NETWORK_fdset_copy_native(), GNUNET_NETWORK_fdset_create(), GNUNET_NETWORK_fdset_destroy(), GNUNET_OK, GNUNET_SCHEDULER_add_select(), GNUNET_SCHEDULER_cancel(), GNUNET_SCHEDULER_PRIORITY_DEFAULT, GNUNET_SYSERR, GNUNET_TIME_relative_multiply(), GNUNET_TIME_UNIT_MILLISECONDS, GNUNET_TIME_UNIT_SECONDS, GNUNET_YES, LOG, GNUNET_ATS_Session::overhead, RequestHandle::s, HTTP_Message::size, and type.

Referenced by client_put_disconnect(), client_run(), http_client_plugin_send(), and http_client_plugin_session_disconnect().

564 {
565  fd_set rs;
566  fd_set ws;
567  fd_set es;
568  int max;
569  struct GNUNET_NETWORK_FDSet *grs;
570  struct GNUNET_NETWORK_FDSet *gws;
571  long to;
572  CURLMcode mret;
574 
575  /* Cancel previous scheduled task */
576  if (plugin->client_perform_task != NULL)
577  {
579  plugin->client_perform_task = NULL;
580  }
581  max = -1;
582  FD_ZERO(&rs);
583  FD_ZERO(&ws);
584  FD_ZERO(&es);
585  mret = curl_multi_fdset(plugin->curl_multi_handle, &rs, &ws, &es, &max);
586  if (mret != CURLM_OK)
587  {
589  _("%s failed at %s:%d: `%s'\n"),
590  "curl_multi_fdset",
591  __FILE__,
592  __LINE__,
593  curl_multi_strerror(mret));
594  return GNUNET_SYSERR;
595  }
596  mret = curl_multi_timeout(plugin->curl_multi_handle, &to);
597  if (-1 == to)
599  else
601  if (now == GNUNET_YES)
603 
604  if (CURLM_OK != mret)
605  {
607  _("%s failed at %s:%d: `%s'\n"),
608  "curl_multi_timeout", __FILE__, __LINE__,
609  curl_multi_strerror(mret));
610  return GNUNET_SYSERR;
611  }
612 
615  GNUNET_NETWORK_fdset_copy_native(grs, &rs, max + 1);
616  GNUNET_NETWORK_fdset_copy_native(gws, &ws, max + 1);
617 
618  /* Schedule task to run when select is ready to read or write */
619  plugin->client_perform_task =
621  timeout, grs, gws,
622  &client_run, plugin);
625  return GNUNET_OK;
626 }
#define GNUNET_TIME_UNIT_SECONDS
One second.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static void client_run(void *cls)
Task performing curl operations.
void GNUNET_NETWORK_fdset_copy_native(struct GNUNET_NETWORK_FDSet *to, const fd_set *from, int nfds)
Copy a native fd set into the GNUnet representation.
Definition: network.c:1108
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
void GNUNET_NETWORK_fdset_destroy(struct GNUNET_NETWORK_FDSet *fds)
Releases the associated memory of an fd set.
Definition: network.c:1254
struct GNUNET_NETWORK_FDSet * GNUNET_NETWORK_fdset_create(void)
Creates an fd set.
Definition: network.c:1238
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:114
collection of IO descriptors
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_select(enum GNUNET_SCHEDULER_Priority prio, struct GNUNET_TIME_Relative delay, const struct GNUNET_NETWORK_FDSet *rs, const struct GNUNET_NETWORK_FDSet *ws, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when any of the specified file descriptor set...
Definition: scheduler.c:1784
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Multiply relative time by a given factor.
Definition: time.c:440
#define GNUNET_TIME_UNIT_MILLISECONDS
One millisecond.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
struct GNUNET_SCHEDULER_Task * client_perform_task
curl perform task
CURLM * curl_multi_handle
cURL Multihandle
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
Run with the default priority (normal P2P operations).
Time for relative time used by GNUnet, in microseconds.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_connect_get()

static int client_connect_get ( struct GNUNET_ATS_Session s)
static

Connect GET request.

Connect GET request for a session.

Parameters
sthe session to connect
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1502 of file plugin_transport_http_client.c.

References GNUNET_HELLO_Address::address, GNUNET_ATS_Session::address, client_receive(), client_send_cb(), RequestHandle::easyhandle, GNUNET_ATS_Session::get, GNUNET_asprintf(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_MAX_MESSAGE_SIZE, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, HTTP_CLIENT_NOT_VALIDATED_TIMEOUT, HTTP_OPTIONS_TCP_STEALTH, HTTP_OPTIONS_VERIFY_CERTIFICATE, LOG, options, HttpAddress::options, GNUNET_ATS_Session::plugin, RequestHandle::s, and GNUNET_ATS_Session::url.

Referenced by client_connect(), client_run(), and client_schedule().

1503 {
1504  CURLMcode mret;
1505  struct HttpAddress *ha;
1506  uint32_t options;
1507 
1508  ha = (struct HttpAddress *)s->address->address;
1509  options = ntohl(ha->options);
1510  /* create get request */
1511  s->get.easyhandle = curl_easy_init();
1512  s->get.s = s;
1513  if (0 != (options & HTTP_OPTIONS_TCP_STEALTH))
1514  {
1515 #ifdef TCP_STEALTH
1516  curl_easy_setopt(s->get.easyhandle,
1517  CURLOPT_OPENSOCKETFUNCTION,
1518  &open_tcp_stealth_socket_cb);
1519  curl_easy_setopt(s->get.easyhandle,
1520  CURLOPT_OPENSOCKETDATA,
1521  s);
1522 #else
1524  "Cannot connect, TCP STEALTH needed and not supported by kernel.\n");
1525  curl_easy_cleanup(s->get.easyhandle);
1526  s->get.easyhandle = NULL;
1527  s->get.s = NULL;
1528  return GNUNET_SYSERR;
1529 #endif
1530  }
1531 
1532 #if VERBOSE_CURL
1533  curl_easy_setopt(s->get.easyhandle,
1534  CURLOPT_VERBOSE,
1535  1L);
1536  curl_easy_setopt(s->get.easyhandle,
1537  CURLOPT_DEBUGFUNCTION,
1538  &client_log);
1539  curl_easy_setopt(s->get.easyhandle,
1540  CURLOPT_DEBUGDATA,
1541  &s->get);
1542 #endif
1543 #if BUILD_HTTPS
1544  curl_easy_setopt(s->get.easyhandle, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1545  {
1547  (options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
1548  {
1549  curl_easy_setopt(s->get.easyhandle,
1550  CURLOPT_SSL_VERIFYPEER, 1L);
1551  curl_easy_setopt(s->get.easyhandle,
1552  CURLOPT_SSL_VERIFYHOST,
1553  2L);
1554  }
1555  else
1556  {
1557  curl_easy_setopt(s->get.easyhandle,
1558  CURLOPT_SSL_VERIFYPEER,
1559  0L);
1560  curl_easy_setopt(s->get.easyhandle,
1561  CURLOPT_SSL_VERIFYHOST,
1562  0L);
1563  }
1564  }
1565  curl_easy_setopt(s->get.easyhandle,
1566  CURLOPT_PROTOCOLS,
1567  CURLPROTO_HTTPS);
1568  curl_easy_setopt(s->get.easyhandle,
1569  CURLOPT_REDIR_PROTOCOLS,
1570  CURLPROTO_HTTPS);
1571 #else
1572  curl_easy_setopt(s->get.easyhandle,
1573  CURLOPT_PROTOCOLS,
1574  CURLPROTO_HTTP);
1575  curl_easy_setopt(s->get.easyhandle,
1576  CURLOPT_REDIR_PROTOCOLS,
1577  CURLPROTO_HTTP);
1578 #endif
1579 
1580  if (NULL != s->plugin->proxy_hostname)
1581  {
1582  curl_easy_setopt(s->get.easyhandle,
1583  CURLOPT_PROXY,
1584  s->plugin->proxy_hostname);
1585  curl_easy_setopt(s->get.easyhandle,
1586  CURLOPT_PROXYTYPE,
1587  s->plugin->proxytype);
1588  if (NULL != s->plugin->proxy_username)
1589  curl_easy_setopt(s->get.easyhandle,
1590  CURLOPT_PROXYUSERNAME,
1591  s->plugin->proxy_username);
1592  if (NULL != s->plugin->proxy_password)
1593  curl_easy_setopt(s->get.easyhandle,
1594  CURLOPT_PROXYPASSWORD,
1595  s->plugin->proxy_password);
1596  if (GNUNET_YES == s->plugin->proxy_use_httpproxytunnel)
1597  curl_easy_setopt(s->get.easyhandle,
1598  CURLOPT_HTTPPROXYTUNNEL,
1599  s->plugin->proxy_use_httpproxytunnel);
1600  }
1601 
1602  if (GNUNET_YES == s->plugin->emulate_xhr)
1603  {
1604  char *url;
1605 
1606  GNUNET_asprintf(&url,
1607  "%s,1",
1608  s->url);
1609  curl_easy_setopt(s->get.easyhandle,
1610  CURLOPT_URL,
1611  url);
1612  GNUNET_free(url);
1613  }
1614  else
1615  {
1616  curl_easy_setopt(s->get.easyhandle,
1617  CURLOPT_URL,
1618  s->url);
1619  }
1620  curl_easy_setopt(s->get.easyhandle,
1621  CURLOPT_READFUNCTION,
1622  &client_send_cb);
1623  curl_easy_setopt(s->get.easyhandle,
1624  CURLOPT_READDATA,
1625  s);
1626  curl_easy_setopt(s->get.easyhandle,
1627  CURLOPT_WRITEFUNCTION,
1628  &client_receive);
1629  curl_easy_setopt(s->get.easyhandle,
1630  CURLOPT_WRITEDATA,
1631  s);
1632  /* No timeout by default, timeout done with session timeout */
1633  curl_easy_setopt(s->get.easyhandle,
1634  CURLOPT_TIMEOUT,
1635  0L);
1636  curl_easy_setopt(s->get.easyhandle,
1637  CURLOPT_PRIVATE, s);
1638  curl_easy_setopt(s->get.easyhandle,
1639  CURLOPT_CONNECTTIMEOUT_MS,
1640  (long)(HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL));
1641  curl_easy_setopt(s->get.easyhandle, CURLOPT_BUFFERSIZE,
1643 #if CURL_TCP_NODELAY
1644  curl_easy_setopt(ps->recv_endpoint,
1645  CURLOPT_TCP_NODELAY,
1646  1L);
1647 #endif
1648  curl_easy_setopt(s->get.easyhandle,
1649  CURLOPT_FOLLOWLOCATION,
1650  0L);
1651 
1652  mret = curl_multi_add_handle(s->plugin->curl_multi_handle,
1653  s->get.easyhandle);
1654  if (CURLM_OK != mret)
1655  {
1657  "Session %p : Failed to add GET handle to multihandle: `%s'\n",
1658  s,
1659  curl_multi_strerror(mret));
1660  curl_easy_cleanup(s->get.easyhandle);
1661  s->get.easyhandle = NULL;
1662  s->get.s = NULL;
1663  GNUNET_break(0);
1664  return GNUNET_SYSERR;
1665  }
1666  s->plugin->cur_requests++;
1668  "GET request `%s' established, number of requests increased to %u\n",
1669  s->url,
1670  s->plugin->cur_requests);
1671  return GNUNET_OK;
1672 }
uint32_t options
Address options see enum HttpAddressOptions
const void * address
Binary representation of the address (plugin-specific).
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
struct Plugin * plugin
Pointer to the global plugin struct.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
struct RequestHandle get
Handle for the HTTP GET request.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
char * url
The URL to connect to.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
#define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT
static size_t client_receive(void *stream, size_t size, size_t nmemb, void *cls)
Callback method used with libcurl when data for a GET request are received.
Enable TCP Stealth-style port knocking.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
#define GNUNET_log(kind,...)
Verify X509 server certificate, it should be valid.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
struct GNUNET_ATS_Session * s
The related session.
CURL * easyhandle
The curl easy handle.
HTTP addresses including a full URI.
#define GNUNET_free(ptr)
Wrapper around free.
static size_t client_send_cb(void *stream, size_t size, size_t nmemb, void *cls)
Callback method used with libcurl Method is called when libcurl needs to read data during sending...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_connect_put()

static int client_connect_put ( struct GNUNET_ATS_Session s)
static

Connect a HTTP put request.

Parameters
sthe session to connect
Returns
GNUNET_SYSERR for hard failure, GNUNET_OK for success
Parameters
sthe session to connect
Returns
GNUNET_SYSERR for hard failure, GNUNET_OK for ok

Definition at line 1682 of file plugin_transport_http_client.c.

References GNUNET_HELLO_Address::address, GNUNET_ATS_Session::address, client_receive_put(), client_send_cb(), RequestHandle::easyhandle, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_MAX_MESSAGE_SIZE, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, H_CONNECTED, H_DISCONNECTED, HTTP_CLIENT_NOT_VALIDATED_TIMEOUT, HTTP_OPTIONS_TCP_STEALTH, HTTP_OPTIONS_VERIFY_CERTIFICATE, LOG, options, HttpAddress::options, GNUNET_ATS_Session::plugin, GNUNET_ATS_Session::put, RequestHandle::s, RequestHandle::state, and GNUNET_ATS_Session::url.

Referenced by client_connect(), client_run(), client_schedule(), and http_client_plugin_send().

1683 {
1684  CURLMcode mret;
1685  struct HttpAddress *ha;
1686  uint32_t options;
1687 
1688  ha = (struct HttpAddress *)s->address->address;
1689  options = ntohl(ha->options);
1690  /* create put request */
1692  "Session %p: Init PUT handle\n",
1693  s);
1694  s->put.easyhandle = curl_easy_init();
1695  s->put.s = s;
1696 #if VERBOSE_CURL
1697  curl_easy_setopt(s->put.easyhandle,
1698  CURLOPT_VERBOSE,
1699  1L);
1700  curl_easy_setopt(s->put.easyhandle,
1701  CURLOPT_DEBUGFUNCTION,
1702  &client_log);
1703  curl_easy_setopt(s->put.easyhandle,
1704  CURLOPT_DEBUGDATA,
1705  &s->put);
1706 #endif
1707  if (0 != (options & HTTP_OPTIONS_TCP_STEALTH))
1708  {
1709 #ifdef TCP_STEALTH
1710  curl_easy_setopt(s->put.easyhandle,
1711  CURLOPT_OPENSOCKETFUNCTION,
1712  &open_tcp_stealth_socket_cb);
1713  curl_easy_setopt(s->put.easyhandle,
1714  CURLOPT_OPENSOCKETDATA,
1715  s);
1716 #else
1718  "Cannot connect, TCP STEALTH needed and not supported by kernel.\n");
1719  curl_easy_cleanup(s->put.easyhandle);
1720  s->put.easyhandle = NULL;
1721  s->put.s = NULL;
1722  s->put.state = H_DISCONNECTED;
1723  return GNUNET_SYSERR;
1724 #endif
1725  }
1726 #if BUILD_HTTPS
1727  curl_easy_setopt(s->put.easyhandle,
1728  CURLOPT_SSLVERSION,
1729  CURL_SSLVERSION_TLSv1);
1730  {
1731  struct HttpAddress *ha;
1732  ha = (struct HttpAddress *)s->address->address;
1733 
1736  {
1737  curl_easy_setopt(s->put.easyhandle,
1738  CURLOPT_SSL_VERIFYPEER,
1739  1L);
1740  curl_easy_setopt(s->put.easyhandle,
1741  CURLOPT_SSL_VERIFYHOST,
1742  2L);
1743  }
1744  else
1745  {
1746  curl_easy_setopt(s->put.easyhandle,
1747  CURLOPT_SSL_VERIFYPEER,
1748  0L);
1749  curl_easy_setopt(s->put.easyhandle,
1750  CURLOPT_SSL_VERIFYHOST,
1751  0L);
1752  }
1753  }
1754  curl_easy_setopt(s->put.easyhandle,
1755  CURLOPT_PROTOCOLS,
1756  CURLPROTO_HTTPS);
1757  curl_easy_setopt(s->put.easyhandle,
1758  CURLOPT_REDIR_PROTOCOLS,
1759  CURLPROTO_HTTPS);
1760 #else
1761  curl_easy_setopt(s->put.easyhandle,
1762  CURLOPT_PROTOCOLS,
1763  CURLPROTO_HTTP);
1764  curl_easy_setopt(s->put.easyhandle,
1765  CURLOPT_REDIR_PROTOCOLS,
1766  CURLPROTO_HTTP);
1767 #endif
1768  if (NULL != s->plugin->proxy_hostname)
1769  {
1770  curl_easy_setopt(s->put.easyhandle,
1771  CURLOPT_PROXY,
1772  s->plugin->proxy_hostname);
1773  curl_easy_setopt(s->put.easyhandle,
1774  CURLOPT_PROXYTYPE,
1775  s->plugin->proxytype);
1776  if (NULL != s->plugin->proxy_username)
1777  curl_easy_setopt(s->put.easyhandle,
1778  CURLOPT_PROXYUSERNAME,
1779  s->plugin->proxy_username);
1780  if (NULL != s->plugin->proxy_password)
1781  curl_easy_setopt(s->put.easyhandle,
1782  CURLOPT_PROXYPASSWORD,
1783  s->plugin->proxy_password);
1784  if (GNUNET_YES == s->plugin->proxy_use_httpproxytunnel)
1785  curl_easy_setopt(s->put.easyhandle,
1786  CURLOPT_HTTPPROXYTUNNEL,
1787  s->plugin->proxy_use_httpproxytunnel);
1788  }
1789 
1790  curl_easy_setopt(s->put.easyhandle,
1791  CURLOPT_URL,
1792  s->url);
1793  curl_easy_setopt(s->put.easyhandle,
1794  CURLOPT_UPLOAD,
1795  1L);
1796  curl_easy_setopt(s->put.easyhandle,
1797  CURLOPT_READFUNCTION,
1798  &client_send_cb);
1799  curl_easy_setopt(s->put.easyhandle,
1800  CURLOPT_READDATA,
1801  s);
1802  curl_easy_setopt(s->put.easyhandle,
1803  CURLOPT_WRITEFUNCTION,
1805  curl_easy_setopt(s->put.easyhandle,
1806  CURLOPT_WRITEDATA,
1807  s);
1808  /* No timeout by default, timeout done with session timeout */
1809  curl_easy_setopt(s->put.easyhandle,
1810  CURLOPT_TIMEOUT,
1811  0L);
1812  curl_easy_setopt(s->put.easyhandle,
1813  CURLOPT_PRIVATE,
1814  s);
1815  curl_easy_setopt(s->put.easyhandle,
1816  CURLOPT_CONNECTTIMEOUT_MS,
1817  (long)(HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL));
1818  curl_easy_setopt(s->put.easyhandle, CURLOPT_BUFFERSIZE,
1820 #if CURL_TCP_NODELAY
1821  curl_easy_setopt(s->put.easyhandle, CURLOPT_TCP_NODELAY, 1);
1822 #endif
1823  mret = curl_multi_add_handle(s->plugin->curl_multi_handle,
1824  s->put.easyhandle);
1825  if (CURLM_OK != mret)
1826  {
1828  "Session %p : Failed to add PUT handle to multihandle: `%s'\n",
1829  s, curl_multi_strerror(mret));
1830  curl_easy_cleanup(s->put.easyhandle);
1831  s->put.easyhandle = NULL;
1832  s->put.s = NULL;
1833  s->put.state = H_DISCONNECTED;
1834  return GNUNET_SYSERR;
1835  }
1836  s->put.state = H_CONNECTED;
1837  s->plugin->cur_requests++;
1838 
1840  "PUT request `%s' established, number of requests increased to %u\n",
1841  s->url, s->plugin->cur_requests);
1842 
1843  return GNUNET_OK;
1844 }
uint32_t options
Address options see enum HttpAddressOptions
const void * address
Binary representation of the address (plugin-specific).
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
struct Plugin * plugin
Pointer to the global plugin struct.
struct RequestHandle put
Handle for the HTTP PUT request.
static size_t client_receive_put(void *stream, size_t size, size_t nmemb, void *cls)
Callback method used with libcurl when data for a PUT request are received.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
int state
The processing state.
char * url
The URL to connect to.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
#define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT
Enable TCP Stealth-style port knocking.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
#define GNUNET_log(kind,...)
Verify X509 server certificate, it should be valid.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
struct GNUNET_ATS_Session * s
The related session.
CURL * easyhandle
The curl easy handle.
HTTP addresses including a full URI.
static size_t client_send_cb(void *stream, size_t size, size_t nmemb, void *cls)
Callback method used with libcurl Method is called when libcurl needs to read data during sending...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_send()

static ssize_t http_client_plugin_send ( void *  cls,
struct GNUNET_ATS_Session s,
const char *  msgbuf,
size_t  msgbuf_size,
unsigned int  priority,
struct GNUNET_TIME_Relative  to,
GNUNET_TRANSPORT_TransmitContinuation  cont,
void *  cont_cls 
)
static

Function that can be used by the transport service to transmit a message using the plugin.

Note that in the case of a peer disconnecting, the continuation MUST be called prior to the disconnect notification itself. This function will be called with this peer's HELLO message to initiate a fresh connection to another peer.

Parameters
clsclosure
swhich session must be used
msgbufthe message to transmit
msgbuf_sizenumber of bytes in msgbuf
priorityhow important is the message (most plugins will ignore message priority and just FIFO)
tohow long to wait at most for the transmission (does not require plugins to discard the message after the timeout, just advisory for the desired delay; most plugins will ignore this as well)
contcontinuation to call once the message has been transmitted (or if the transport is ready for the next transmission call; or if the peer disconnected...); can be NULL
cont_clsclosure for cont
Returns
number of bytes used (on the physical network, with overheads); -1 on hard errors (i.e. address invalid); 0 is a legal value and does NOT mean that the message was not transmitted (DV)

Definition at line 745 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, HTTP_Message::buf, GNUNET_ATS_Session::bytes_in_queue, client_connect_put(), client_schedule(), RequestHandle::easyhandle, HTTP_Client_Plugin::env, GNUNET_asprintf(), GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_malloc, GNUNET_memcpy, GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_update(), GNUNET_SYSERR, GNUNET_TRANSPORT_SS_UPDATE, GNUNET_YES, H_CONNECTED, H_PAUSED, H_TMP_DISCONNECTED, H_TMP_DISCONNECTING, H_TMP_RECONNECT_REQUIRED, http_client_plugin_session_disconnect(), LOG, msg, GNUNET_ATS_Session::msg_head, GNUNET_ATS_Session::msg_tail, GNUNET_ATS_Session::msgs_in_queue, notify_session_monitor(), GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, HTTP_Client_Plugin::protocol, GNUNET_ATS_Session::put, GNUNET_ATS_Session::put_disconnect_task, HTTP_Message::size, RequestHandle::state, GNUNET_TRANSPORT_PluginEnvironment::stats, HTTP_Message::transmit_cont, and HTTP_Message::transmit_cont_cls.

Referenced by libgnunet_plugin_transport_http_client_init().

753 {
754  struct HTTP_Client_Plugin *plugin = cls;
755  struct HTTP_Message *msg;
756  char *stat_txt;
757 
759  "Session %p/request %p: Sending message with %u to peer `%s' \n",
760  s,
761  s->put.easyhandle,
762  msgbuf_size,
763  GNUNET_i2s(&s->address->peer));
764 
765  /* create new message and schedule */
766  msg = GNUNET_malloc(sizeof(struct HTTP_Message) + msgbuf_size);
767  msg->size = msgbuf_size;
768  msg->buf = (char *)&msg[1];
769  msg->transmit_cont = cont;
770  msg->transmit_cont_cls = cont_cls;
771  GNUNET_memcpy(msg->buf,
772  msgbuf,
773  msgbuf_size);
775  s->msg_tail,
776  msg);
777  s->msgs_in_queue++;
778  s->bytes_in_queue += msg->size;
779 
780  GNUNET_asprintf(&stat_txt,
781  "# bytes currently in %s_client buffers",
782  plugin->protocol);
784  stat_txt, msgbuf_size, GNUNET_NO);
785  GNUNET_free(stat_txt);
786  notify_session_monitor(plugin,
787  s,
789  if (H_TMP_DISCONNECTING == s->put.state)
790  {
791  /* PUT request is currently getting disconnected */
794  "Session %p/request %p: currently disconnecting, reconnecting immediately\n",
795  s,
796  s->put.easyhandle);
797  return msgbuf_size;
798  }
799  if (H_PAUSED == s->put.state)
800  {
801  /* PUT request was paused, unpause */
804  s->put_disconnect_task = NULL;
806  "Session %p/request %p: unpausing request\n",
807  s, s->put.easyhandle);
808  s->put.state = H_CONNECTED;
809  if (NULL != s->put.easyhandle)
810  curl_easy_pause(s->put.easyhandle, CURLPAUSE_CONT);
811  }
812  else if (H_TMP_DISCONNECTED == s->put.state)
813  {
814  /* PUT request was disconnected, reconnect */
815  LOG(GNUNET_ERROR_TYPE_DEBUG, "Session %p: Reconnecting PUT request\n", s);
816  GNUNET_break(NULL == s->put.easyhandle);
818  {
819  /* Could not reconnect */
821  return GNUNET_SYSERR;
822  }
823  }
825  return msgbuf_size;
826 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static int http_client_plugin_session_disconnect(void *cls, struct GNUNET_ATS_Session *s)
Disconnect a session.
char * buf
buffer containing data to send
unsigned int msgs_in_queue
Number of messages waiting for transmission to this peer.
struct HTTP_Message * msg_tail
previous pointer for double linked list
struct Plugin * plugin
Pointer to the global plugin struct.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
Message to send using http.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct HTTP_Message * msg_head
next pointer for double linked list
struct GNUNET_SCHEDULER_Task * put_disconnect_task
Session timeout task.
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
unsigned long long bytes_in_queue
Number of bytes waiting for transmission to this peer.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void * transmit_cont_cls
Closure for transmit_cont.
GNUNET_TRANSPORT_TransmitContinuation transmit_cont
Continuation function to call once the transmission buffer has again space available.
Paused, nothing to send.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
Temporarily disconnected.
static int client_schedule(struct HTTP_Client_Plugin *plugin, int now)
Function setting up file descriptors and scheduling task to run.
static int client_connect_put(struct GNUNET_ATS_Session *s)
Connect a HTTP put request.
int state
The processing state.
size_t size
buffer length
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Encapsulation of all of the state of the plugin.
This is just an update about the session, the state did not change.
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
Temporary disconnect in progress due to inactivity.
CURL * easyhandle
The curl easy handle.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
Send request while temporary disconnect, reconnect.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_query_keepalive_factor()

static unsigned int http_client_query_keepalive_factor ( void *  cls)
static

Function that is called to get the keepalive factor.

GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to calculate the interval between keepalive packets.

Parameters
clsclosure with the struct Plugin
Returns
keepalive factor

Definition at line 871 of file plugin_transport_http_client.c.

Referenced by libgnunet_plugin_transport_http_client_init().

872 {
873  return 3;
874 }
Here is the caller graph for this function:

◆ destroy_session_cb()

static int destroy_session_cb ( void *  cls,
const struct GNUNET_PeerIdentity peer,
void *  value 
)
static

Callback to destroys all sessions on exit.

Parameters
clsthe struct HTTP_Client_Plugin *
peeridentity of the peer
valuethe struct GNUNET_ATS_Session *
Returns
GNUNET_OK (continue iterating)

Definition at line 886 of file plugin_transport_http_client.c.

References GNUNET_OK, http_client_plugin_session_disconnect(), plugin, and value.

Referenced by http_client_plugin_peer_disconnect(), and libgnunet_plugin_transport_http_client_done().

889 {
890  struct HTTP_Client_Plugin *plugin = cls;
891  struct GNUNET_ATS_Session *session = value;
892 
893  http_client_plugin_session_disconnect(plugin, session);
894  return GNUNET_OK;
895 }
static int http_client_plugin_session_disconnect(void *cls, struct GNUNET_ATS_Session *s)
Disconnect a session.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
static char * value
Value of the record to add/remove.
Information about ongoing sessions of the transport client.
Encapsulation of all of the state of the plugin.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_peer_disconnect()

static void http_client_plugin_peer_disconnect ( void *  cls,
const struct GNUNET_PeerIdentity target 
)
static

Function that can be used to force the plugin to disconnect from the given peer and cancel all previous transmissions (and their continuationc).

Parameters
clsclosure
targetpeer from which to disconnect

Definition at line 907 of file plugin_transport_http_client.c.

References destroy_session_cb(), GNUNET_CONTAINER_multipeermap_get_multiple(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), LOG, plugin, and HTTP_Client_Plugin::sessions.

Referenced by libgnunet_plugin_transport_http_client_init().

909 {
910  struct HTTP_Client_Plugin *plugin = cls;
911 
913  "Transport tells me to disconnect `%s'\n",
914  GNUNET_i2s(target));
916  target,
918  plugin);
919 }
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
static int destroy_session_cb(void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
Callback to destroys all sessions on exit.
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
Encapsulation of all of the state of the plugin.
#define LOG(kind,...)
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
int GNUNET_CONTAINER_multipeermap_get_multiple(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map that match a particular key.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ session_lookup_client_by_address()

static int session_lookup_client_by_address ( void *  cls,
const struct GNUNET_PeerIdentity key,
void *  value 
)
static

Locate the seession object for a given address.

Parameters
clsthe struct GNUNET_ATS_SessionClientCtx *
keypeer identity
valuethe struct GNUNET_ATS_Session to check
Returns
GNUNET_NO if found, GNUNET_OK if not

Definition at line 947 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, GNUNET_ATS_SessionClientCtx::address, GNUNET_HELLO_address_cmp(), GNUNET_NO, GNUNET_YES, GNUNET_ATS_SessionClientCtx::ret, and value.

Referenced by client_lookup_session().

950 {
951  struct GNUNET_ATS_SessionClientCtx *sc_ctx = cls;
952  struct GNUNET_ATS_Session *s = value;
953 
954  if (0 == GNUNET_HELLO_address_cmp(sc_ctx->address,
955  s->address))
956  {
957  sc_ctx->ret = s;
958  return GNUNET_NO;
959  }
960  return GNUNET_YES;
961 }
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_HELLO_Address * address
Address.
const struct GNUNET_HELLO_Address * address
Address we are looking for.
int GNUNET_HELLO_address_cmp(const struct GNUNET_HELLO_Address *a1, const struct GNUNET_HELLO_Address *a2)
Compare two addresses.
Definition: address.c:130
static char * value
Value of the record to add/remove.
Information about ongoing sessions of the transport client.
Closure for session_lookup_client_by_address().
struct GNUNET_ATS_Session * ret
Session that was found.
#define GNUNET_YES
Definition: gnunet_common.h:77
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_lookup_session()

static struct GNUNET_ATS_Session* client_lookup_session ( struct HTTP_Client_Plugin plugin,
const struct GNUNET_HELLO_Address address 
)
static

Check if a sessions exists for an specific address.

Parameters
pluginthe plugin
addressthe address
Returns
the session or NULL

Definition at line 972 of file plugin_transport_http_client.c.

References address, GNUNET_ATS_SessionClientCtx::address, GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_ATS_SessionClientCtx::ret, session_lookup_client_by_address(), and HTTP_Client_Plugin::sessions.

Referenced by http_client_plugin_get_session().

974 {
975  struct GNUNET_ATS_SessionClientCtx sc_ctx;
976 
977  sc_ctx.address = address;
978  sc_ctx.ret = NULL;
981  &sc_ctx);
982  return sc_ctx.ret;
983 }
const struct GNUNET_HELLO_Address * address
Address we are looking for.
static int session_lookup_client_by_address(void *cls, const struct GNUNET_PeerIdentity *key, void *value)
Locate the seession object for a given address.
Closure for session_lookup_client_by_address().
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
static char * address
GNS address for this phone.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_put_disconnect()

static void client_put_disconnect ( void *  cls)
static

When we have nothing to transmit, we pause the HTTP PUT after a while (so that gnurl stops asking).

This task is the delayed task that actually disconnects the PUT.

Parameters
clsthe struct GNUNET_ATS_Session * with the put

Definition at line 994 of file plugin_transport_http_client.c.

References client_schedule(), RequestHandle::easyhandle, GNUNET_ERROR_TYPE_DEBUG, GNUNET_YES, H_TMP_DISCONNECTING, LOG, GNUNET_ATS_Session::plugin, GNUNET_ATS_Session::put, GNUNET_ATS_Session::put_disconnect_task, and RequestHandle::state.

Referenced by client_send_cb().

995 {
996  struct GNUNET_ATS_Session *s = cls;
997 
998  s->put_disconnect_task = NULL;
1000  "Session %p/request %p: will be disconnected due to no activity\n",
1001  s, s->put.easyhandle);
1003  if (NULL != s->put.easyhandle)
1004  curl_easy_pause(s->put.easyhandle,
1005  CURLPAUSE_CONT);
1007 }
struct Plugin * plugin
Pointer to the global plugin struct.
struct RequestHandle put
Handle for the HTTP PUT request.
struct GNUNET_SCHEDULER_Task * put_disconnect_task
Session timeout task.
static int client_schedule(struct HTTP_Client_Plugin *plugin, int now)
Function setting up file descriptors and scheduling task to run.
Information about ongoing sessions of the transport client.
int state
The processing state.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
Temporary disconnect in progress due to inactivity.
CURL * easyhandle
The curl easy handle.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_send_cb()

static size_t client_send_cb ( void *  stream,
size_t  size,
size_t  nmemb,
void *  cls 
)
static

Callback method used with libcurl Method is called when libcurl needs to read data during sending.

Parameters
streampointer where to write data
sizesize of an individual element
nmembcount of elements that can be written to the buffer
clsour struct GNUNET_ATS_Session
Returns
bytes written to stream, returning 0 will terminate request!

Definition at line 1021 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::address, HTTP_Message::buf, GNUNET_ATS_Session::bytes_in_queue, client_put_disconnect(), RequestHandle::easyhandle, HTTP_Client_Plugin::emulate_xhr, HTTP_Client_Plugin::env, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_memcpy, GNUNET_MIN, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_STATISTICS_update(), GNUNET_TRANSPORT_SS_UPDATE, GNUNET_YES, H_PAUSED, H_TMP_DISCONNECTING, len, LOG, msg, GNUNET_ATS_Session::msg_head, GNUNET_ATS_Session::msg_tail, GNUNET_ATS_Session::msgs_in_queue, notify_session_monitor(), GNUNET_ATS_Session::overhead, GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, HTTP_Message::pos, HTTP_Client_Plugin::protocol, GNUNET_ATS_Session::put, GNUNET_ATS_Session::put_disconnect_task, PUT_DISCONNECT_TIMEOUT, HTTP_Message::size, RequestHandle::state, GNUNET_TRANSPORT_PluginEnvironment::stats, HTTP_Message::transmit_cont, and HTTP_Message::transmit_cont_cls.

Referenced by client_connect_get(), and client_connect_put().

1025 {
1026  struct GNUNET_ATS_Session *s = cls;
1027  struct HTTP_Client_Plugin *plugin = s->plugin;
1028  struct HTTP_Message *msg = s->msg_head;
1029  size_t len;
1030  char *stat_txt;
1031 
1032  if (H_TMP_DISCONNECTING == s->put.state)
1033  {
1035  "Session %p/request %p: disconnect due to inactivity\n",
1036  s, s->put.easyhandle);
1037  return 0;
1038  }
1039 
1040  if (NULL == msg)
1041  {
1042  if (GNUNET_YES == plugin->emulate_xhr)
1043  {
1045  "Session %p/request %p: PUT request finished\n",
1046  s,
1047  s->put.easyhandle);
1049  return 0;
1050  }
1051 
1052  /* We have nothing to send, so pause PUT request */
1054  "Session %p/request %p: nothing to send, suspending\n",
1055  s,
1056  s->put.easyhandle);
1060  s);
1061  s->put.state = H_PAUSED;
1062  return CURL_READFUNC_PAUSE;
1063  }
1064  /* data to send */
1065  GNUNET_assert(msg->pos < msg->size);
1066  /* calculate how much fits in buffer */
1067  len = GNUNET_MIN(msg->size - msg->pos,
1068  size * nmemb);
1069  GNUNET_memcpy(stream,
1070  &msg->buf[msg->pos],
1071  len);
1072  msg->pos += len;
1073  if (msg->pos == msg->size)
1074  {
1076  "Session %p/request %p: sent message with %u bytes sent, removing message from queue\n",
1077  s,
1078  s->put.easyhandle,
1079  msg->size,
1080  msg->pos);
1081  /* Calling transmit continuation */
1083  s->msg_tail,
1084  msg);
1085  GNUNET_assert(0 < s->msgs_in_queue);
1086  s->msgs_in_queue--;
1087  GNUNET_assert(msg->size <= s->bytes_in_queue);
1088  s->bytes_in_queue -= msg->size;
1089  if (NULL != msg->transmit_cont)
1090  msg->transmit_cont(msg->transmit_cont_cls,
1091  &s->address->peer,
1092  GNUNET_OK,
1093  msg->size,
1094  msg->size + s->overhead);
1095  s->overhead = 0;
1096  GNUNET_free(msg);
1097  }
1098  notify_session_monitor(plugin,
1099  s,
1101  GNUNET_asprintf(&stat_txt,
1102  "# bytes currently in %s_client buffers",
1103  plugin->protocol);
1105  stat_txt,
1106  -len,
1107  GNUNET_NO);
1108  GNUNET_free(stat_txt);
1109  GNUNET_asprintf(&stat_txt,
1110  "# bytes transmitted via %s_client",
1111  plugin->protocol);
1113  stat_txt,
1114  len,
1115  GNUNET_NO);
1116  GNUNET_free(stat_txt);
1117  return len;
1118 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
char * buf
buffer containing data to send
unsigned int msgs_in_queue
Number of messages waiting for transmission to this peer.
struct HTTP_Message * msg_tail
previous pointer for double linked list
struct Plugin * plugin
Pointer to the global plugin struct.
#define PUT_DISCONNECT_TIMEOUT
size_t pos
amount of data already sent
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
Message to send using http.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct HTTP_Message * msg_head
next pointer for double linked list
struct GNUNET_SCHEDULER_Task * put_disconnect_task
Session timeout task.
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
unsigned long long bytes_in_queue
Number of bytes waiting for transmission to this peer.
void * transmit_cont_cls
Closure for transmit_cont.
GNUNET_TRANSPORT_TransmitContinuation transmit_cont
Continuation function to call once the transmission buffer has again space available.
Paused, nothing to send.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
static void client_put_disconnect(void *cls)
When we have nothing to transmit, we pause the HTTP PUT after a while (so that gnurl stops asking)...
Information about ongoing sessions of the transport client.
#define GNUNET_MIN(a, b)
Definition: gnunet_common.h:80
int state
The processing state.
size_t size
buffer length
static unsigned int size
Size of the "table".
Definition: peer.c:66
int emulate_xhr
Should we emulate an XHR client for testing?
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Encapsulation of all of the state of the plugin.
This is just an update about the session, the state did not change.
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
size_t overhead
Outbound overhead due to HTTP connection Add to next message of this session when calling callback...
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
Temporary disconnect in progress due to inactivity.
CURL * easyhandle
The curl easy handle.
#define GNUNET_free(ptr)
Wrapper around free.
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_wake_up()

static void client_wake_up ( void *  cls)
static

Wake up a curl handle which was suspended.

Parameters
clsthe session

Definition at line 1127 of file plugin_transport_http_client.c.

References RequestHandle::easyhandle, GNUNET_ATS_Session::get, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_SCHEDULER_cancel(), H_CONNECTED, H_PAUSED, LOG, GNUNET_ATS_Session::put, GNUNET_ATS_Session::put_disconnect_task, GNUNET_ATS_Session::recv_wakeup_task, and RequestHandle::state.

Referenced by client_receive(), and http_client_plugin_update_inbound_delay().

1128 {
1129  struct GNUNET_ATS_Session *s = cls;
1130 
1131  s->recv_wakeup_task = NULL;
1133  "Session %p/request %p: Waking up GET handle\n",
1134  s, s->get.easyhandle);
1135  if (H_PAUSED == s->put.state)
1136  {
1137  /* PUT request was paused, unpause */
1138  GNUNET_assert(s->put_disconnect_task != NULL);
1140  s->put_disconnect_task = NULL;
1141  s->put.state = H_CONNECTED;
1142  if (NULL != s->put.easyhandle)
1143  curl_easy_pause(s->put.easyhandle, CURLPAUSE_CONT);
1144  }
1145  if (NULL != s->get.easyhandle)
1146  curl_easy_pause(s->get.easyhandle, CURLPAUSE_CONT);
1147 }
struct GNUNET_SCHEDULER_Task * recv_wakeup_task
Task to wake up client receive handle when receiving is allowed again.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
struct RequestHandle get
Handle for the HTTP GET request.
struct GNUNET_SCHEDULER_Task * put_disconnect_task
Session timeout task.
Paused, nothing to send.
Information about ongoing sessions of the transport client.
int state
The processing state.
#define LOG(kind,...)
CURL * easyhandle
The curl easy handle.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_receive_mst_cb()

static int client_receive_mst_cb ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Callback for message stream tokenizer.

Parameters
clsthe session
messagethe message received
Returns
always GNUNET_OK

Definition at line 1158 of file plugin_transport_http_client.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_HELLO_Address::address, GNUNET_ATS_Session::address, GNUNET_HELLO_Address::address_length, client_reschedule_session_timeout(), GNUNET_TRANSPORT_PluginEnvironment::cls, Plugin::env, HTTP_Client_Plugin::env, GNUNET_asprintf(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_NO, GNUNET_OK, GNUNET_STATISTICS_update(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get(), GNUNET_TIME_relative_to_absolute(), GNUNET_YES, http_common_plugin_address_to_string(), LOG, GNUNET_ATS_Session::next_receive, GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, Plugin::protocol, HTTP_Client_Plugin::protocol, GNUNET_MessageHeader::size, and GNUNET_TRANSPORT_PluginEnvironment::stats.

Referenced by client_receive().

1160 {
1161  struct GNUNET_ATS_Session *s = cls;
1162  struct HTTP_Client_Plugin *plugin;
1163  struct GNUNET_TIME_Relative delay;
1164  char *stat_txt;
1165 
1166  plugin = s->plugin;
1167  delay = s->plugin->env->receive(plugin->env->cls,
1168  s->address,
1169  s,
1170  message);
1171  GNUNET_asprintf(&stat_txt,
1172  "# bytes received via %s_client",
1173  plugin->protocol);
1175  stat_txt,
1176  ntohs(message->size),
1177  GNUNET_NO);
1178  GNUNET_free(stat_txt);
1179 
1181  if (GNUNET_TIME_absolute_get().abs_value_us < s->next_receive.abs_value_us)
1182  {
1184  "Client: peer `%s' address `%s' next read delayed for %s\n",
1185  GNUNET_i2s(&s->address->peer),
1187  s->address->address,
1188  s->address->address_length),
1190  GNUNET_YES));
1191  }
1193  return GNUNET_OK;
1194 }
size_t address_length
Number of bytes in address.
const void * address
Binary representation of the address (plugin-specific).
struct Plugin * plugin
Pointer to the global plugin struct.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
char * protocol
Plugin protocol http, https.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
uint64_t abs_value_us
The actual value.
struct GNUNET_TIME_Absolute next_receive
Absolute time when to receive data again Used for receive throttling.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
void * cls
Closure for the various callbacks.
Information about ongoing sessions of the transport client.
struct GNUNET_DATACACHE_PluginEnvironment * env
Our execution environment.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static void client_reschedule_session_timeout(struct GNUNET_ATS_Session *s)
Increment session timeout due to activity for session s.
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Encapsulation of all of the state of the plugin.
const char * http_common_plugin_address_to_string(const char *plugin, const void *addr, size_t addrlen)
Function called for a quick conversion of the binary address to a numeric address.
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_receive_put()

static size_t client_receive_put ( void *  stream,
size_t  size,
size_t  nmemb,
void *  cls 
)
static

Callback method used with libcurl when data for a PUT request are received.

We do not expect data here, so we just discard it.

Parameters
streampointer where to write data
sizesize of an individual element
nmembcount of elements that can be written to the buffer
clsdestination pointer, passed to the libcurl handle
Returns
bytes read from stream

Definition at line 1208 of file plugin_transport_http_client.c.

Referenced by client_connect_put().

1212 {
1213  return size * nmemb;
1214 }
static unsigned int size
Size of the "table".
Definition: peer.c:66
Here is the caller graph for this function:

◆ client_receive()

static size_t client_receive ( void *  stream,
size_t  size,
size_t  nmemb,
void *  cls 
)
static

Callback method used with libcurl when data for a GET request are received.

Forward to MST

Parameters
streampointer where to write data
sizesize of an individual element
nmembcount of elements that can be written to the buffer
clsdestination pointer, passed to the libcurl handle
Returns
bytes read from stream

Definition at line 1228 of file plugin_transport_http_client.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_ATS_Session::address, client_receive_mst_cb(), client_wake_up(), RequestHandle::easyhandle, GNUNET_ATS_Session::get, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_MST_create(), GNUNET_MST_from_buffer(), GNUNET_NO, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_cancel(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_difference(), GNUNET_YES, len, LOG, GNUNET_ATS_Session::msg_tk, GNUNET_ATS_Session::next_receive, GNUNET_HELLO_Address::peer, and GNUNET_ATS_Session::recv_wakeup_task.

Referenced by client_connect_get().

1232 {
1233  struct GNUNET_ATS_Session *s = cls;
1234  struct GNUNET_TIME_Absolute now;
1235  size_t len = size * nmemb;
1236 
1238  "Session %p / request %p: Received %u bytes from peer `%s'\n",
1239  s,
1240  s->get.easyhandle,
1241  len,
1242  GNUNET_i2s(&s->address->peer));
1243  now = GNUNET_TIME_absolute_get();
1244  if (now.abs_value_us < s->next_receive.abs_value_us)
1245  {
1249 
1251  "Session %p / request %p: No inbound bandwidth available! Next read was delayed for %s\n",
1252  s,
1253  s->get.easyhandle,
1255  GNUNET_YES));
1256  if (s->recv_wakeup_task != NULL)
1257  {
1259  s->recv_wakeup_task = NULL;
1260  }
1261  s->recv_wakeup_task
1263  &client_wake_up,
1264  s);
1265  return CURL_WRITEFUNC_PAUSE;
1266  }
1267  if (NULL == s->msg_tk)
1269  s);
1271  stream,
1272  len,
1273  GNUNET_NO,
1274  GNUNET_NO);
1275  return len;
1276 }
static int client_receive_mst_cb(void *cls, const struct GNUNET_MessageHeader *message)
Callback for message stream tokenizer.
struct GNUNET_SCHEDULER_Task * recv_wakeup_task
Task to wake up client receive handle when receiving is allowed again.
static struct GNUNET_TIME_Relative delta
Definition: speedup.c:35
struct GNUNET_SERVER_MessageStreamTokenizer * msg_tk
Message stream tokenizer for incoming data.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_HELLO_Address * address
Address.
static void client_wake_up(void *cls)
Wake up a curl handle which was suspended.
struct RequestHandle get
Handle for the HTTP GET request.
uint64_t abs_value_us
The actual value.
struct GNUNET_TIME_Absolute next_receive
Absolute time when to receive data again Used for receive throttling.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
Information about ongoing sessions of the transport client.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
struct GNUNET_MessageStreamTokenizer * GNUNET_MST_create(GNUNET_MessageTokenizerCallback cb, void *cb_cls)
Create a message stream tokenizer.
Definition: mst.c:84
int GNUNET_MST_from_buffer(struct GNUNET_MessageStreamTokenizer *mst, const char *buf, size_t size, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
Definition: mst.c:113
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static unsigned int size
Size of the "table".
Definition: peer.c:66
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_difference(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Absolute end)
Compute the time difference between the given start and end times.
Definition: time.c:353
#define LOG(kind,...)
CURL * easyhandle
The curl easy handle.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Time for relative time used by GNUnet, in microseconds.
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_connect()

static int client_connect ( struct GNUNET_ATS_Session s)
static

Connect both PUT and GET request for a session.

Parameters
sthe session to connect
Returns
GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1854 of file plugin_transport_http_client.c.

References GNUNET_HELLO_Address::address, GNUNET_ATS_Session::address, GNUNET_HELLO_Address::address_length, client_connect_get(), client_connect_put(), HTTP_Client_Plugin::client_perform_task, client_run(), HTTP_Client_Plugin::cur_requests, RequestHandle::easyhandle, HTTP_Client_Plugin::emulate_xhr, HTTP_Client_Plugin::env, GNUNET_ATS_Session::get, GNUNET_asprintf(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_i2s_full(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_set(), GNUNET_SYSERR, GNUNET_YES, H_TMP_DISCONNECTED, http_common_plugin_address_to_string(), http_common_plugin_address_to_url(), HTTP_STAT_STR_CONNECTIONS, HTTP_Client_Plugin::last_tag, LOG, GNUNET_TRANSPORT_PluginEnvironment::my_identity, GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, HTTP_Client_Plugin::protocol, GNUNET_ATS_Session::put, res, RequestHandle::state, GNUNET_TRANSPORT_PluginEnvironment::stats, and GNUNET_ATS_Session::url.

Referenced by http_client_plugin_get_session().

1855 {
1856  struct HTTP_Client_Plugin *plugin = s->plugin;
1857  int res = GNUNET_OK;
1858 
1859  /* create url */
1860  if (NULL ==
1862  s->address->address,
1863  s->address->address_length))
1864  {
1866  "Invalid address peer `%s'\n",
1867  GNUNET_i2s(&s->address->peer));
1868  return GNUNET_SYSERR;
1869  }
1870 
1871  GNUNET_asprintf(&s->url,
1872  "%s/%s;%u",
1874  s->address->address,
1875  s->address->address_length),
1876  GNUNET_i2s_full(plugin->env->my_identity),
1877  plugin->last_tag);
1878 
1879  plugin->last_tag++;
1881  "Initiating outbound session peer `%s' using address `%s'\n",
1882  GNUNET_i2s(&s->address->peer), s->url);
1883 
1885  return GNUNET_SYSERR;
1886  /* If we are emulating an XHR client then delay sending a PUT request until
1887  * there is something to send.
1888  */
1889  if (GNUNET_YES == plugin->emulate_xhr)
1890  {
1892  }
1893  else if (GNUNET_SYSERR == client_connect_put(s))
1894  return GNUNET_SYSERR;
1895 
1897  "Session %p: connected with GET %p and PUT %p\n",
1898  s, s->get.easyhandle,
1899  s->put.easyhandle);
1900  /* Perform connect */
1901  GNUNET_STATISTICS_set(plugin->env->stats,
1903  plugin->cur_requests,
1904  GNUNET_NO);
1905  /* Re-schedule since handles have changed */
1906  if (NULL != plugin->client_perform_task)
1907  {
1909  plugin->client_perform_task = NULL;
1910  }
1911 
1912  /* Schedule task to run immediately */
1914  plugin);
1915  return res;
1916 }
size_t address_length
Number of bytes in address.
const void * address
Binary representation of the address (plugin-specific).
uint32_t last_tag
Last used unique HTTP connection tag.
struct Plugin * plugin
Pointer to the global plugin struct.
const char * http_common_plugin_address_to_url(void *cls, const void *addr, size_t addrlen)
FIXME.
static int client_connect_get(struct GNUNET_ATS_Session *s)
Connect GET request.
struct RequestHandle put
Handle for the HTTP PUT request.
const struct GNUNET_PeerIdentity * my_identity
Identity of this peer.
#define GNUNET_NO
Definition: gnunet_common.h:78
const char * GNUNET_i2s_full(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static void client_run(void *cls)
Task performing curl operations.
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct RequestHandle get
Handle for the HTTP GET request.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
Temporarily disconnected.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1264
void GNUNET_STATISTICS_set(struct GNUNET_STATISTICS_Handle *handle, const char *name, uint64_t value, int make_persistent)
Set statistic value for the peer.
static int client_connect_put(struct GNUNET_ATS_Session *s)
Connect a HTTP put request.
int state
The processing state.
static int res
char * url
The URL to connect to.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
int emulate_xhr
Should we emulate an XHR client for testing?
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Encapsulation of all of the state of the plugin.
const char * http_common_plugin_address_to_string(const char *plugin, const void *addr, size_t addrlen)
Function called for a quick conversion of the binary address to a numeric address.
struct GNUNET_SCHEDULER_Task * client_perform_task
curl perform task
unsigned int cur_requests
Current number of sockets the plugin can use Each http connections are two requests.
#define HTTP_STAT_STR_CONNECTIONS
struct GNUNET_STATISTICS_Handle * stats
Handle for reporting statistics.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
CURL * easyhandle
The curl easy handle.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_get_network()

static enum GNUNET_NetworkType http_client_plugin_get_network ( void *  cls,
struct GNUNET_ATS_Session session 
)
static

Function obtain the network type for a session.

Parameters
clsclosure (struct Plugin*)
sessionthe session
Returns
the network type

Definition at line 1927 of file plugin_transport_http_client.c.

References GNUNET_ATS_Session::scope.

Referenced by libgnunet_plugin_transport_http_client_init().

1929 {
1930  return session->scope;
1931 }
enum GNUNET_NetworkType scope
ATS network type.
Here is the caller graph for this function:

◆ http_client_plugin_get_network_for_address()

static enum GNUNET_NetworkType http_client_plugin_get_network_for_address ( void *  cls,
const struct GNUNET_HELLO_Address address 
)
static

Function obtain the network type for an address.

Parameters
clsclosure (struct Plugin *)
addressthe address
Returns
the network type

Definition at line 1942 of file plugin_transport_http_client.c.

References HTTP_Client_Plugin::env, http_common_get_network_for_address(), and plugin.

Referenced by libgnunet_plugin_transport_http_client_init().

1944 {
1945  struct HTTP_Client_Plugin *plugin = cls;
1946 
1948  address);
1949 }
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
Encapsulation of all of the state of the plugin.
enum GNUNET_NetworkType http_common_get_network_for_address(struct GNUNET_TRANSPORT_PluginEnvironment *env, const struct GNUNET_HELLO_Address *address)
Function obtain the network type for an address.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_session_timeout()

static void client_session_timeout ( void *  cls)
static

Session was idle, so disconnect it.

Parameters
clsthe struct GNUNET_ATS_Session of the idle session

Definition at line 1958 of file plugin_transport_http_client.c.

References GNUNET_assert, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_remaining(), GNUNET_TRANSPORT_SS_UPDATE, GNUNET_YES, http_client_plugin_session_disconnect(), HTTP_CLIENT_SESSION_TIMEOUT, LOG, notify_session_monitor(), GNUNET_ATS_Session::plugin, GNUNET_TIME_Relative::rel_value_us, GNUNET_ATS_Session::timeout, TIMEOUT_LOG, and GNUNET_ATS_Session::timeout_task.

Referenced by http_client_plugin_get_session().

1959 {
1960  struct GNUNET_ATS_Session *s = cls;
1961  struct GNUNET_TIME_Relative left;
1962 
1963  s->timeout_task = NULL;
1965  if (0 != left.rel_value_us)
1966  {
1967  /* not actually our turn yet, but let's at least update
1968  the monitor, it may think we're about to die ... */
1970  s,
1974  s);
1975  return;
1976  }
1977  LOG(TIMEOUT_LOG,
1978  "Session %p was idle for %s, disconnecting\n",
1979  s,
1981  GNUNET_YES));
1984  s));
1985 }
#define HTTP_CLIENT_SESSION_TIMEOUT
static int http_client_plugin_session_disconnect(void *cls, struct GNUNET_ATS_Session *s)
Disconnect a session.
struct GNUNET_SCHEDULER_Task * timeout_task
Session timeout task.
struct Plugin * plugin
Pointer to the global plugin struct.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static void client_session_timeout(void *cls)
Session was idle, so disconnect it.
struct GNUNET_TIME_Absolute timeout
When does this session time out.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
Information about ongoing sessions of the transport client.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
This is just an update about the session, the state did not change.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
#define TIMEOUT_LOG
Time for relative time used by GNUnet, in microseconds.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_get_session()

static struct GNUNET_ATS_Session* http_client_plugin_get_session ( void *  cls,
const struct GNUNET_HELLO_Address address 
)
static

Creates a new outbound session the transport service will use to send data to the peer.

Parameters
clsthe plugin
addressthe address
Returns
the session or NULL of max connections exceeded

Definition at line 1997 of file plugin_transport_http_client.c.

References GNUNET_HELLO_Address::address, GNUNET_ATS_Session::address, GNUNET_HELLO_Address::address_length, client_connect(), client_delete_session(), client_lookup_session(), client_session_timeout(), GNUNET_TRANSPORT_PluginEnvironment::cls, HTTP_Client_Plugin::cur_requests, HTTP_Client_Plugin::env, GNUNET_TRANSPORT_PluginEnvironment::get_address_type, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_CONTAINER_multipeermap_put(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_HELLO_address_copy(), GNUNET_i2s(), GNUNET_new, GNUNET_NO, GNUNET_NT_UNSPECIFIED, GNUNET_NT_WAN, GNUNET_SCHEDULER_add_delayed(), GNUNET_SYSERR, GNUNET_TIME_relative_to_absolute(), GNUNET_TRANSPORT_SS_INIT, GNUNET_TRANSPORT_SS_UP, GNUNET_YES, H_NOT_CONNECTED, HTTP_CLIENT_SESSION_TIMEOUT, http_common_plugin_address_to_string(), http_common_socket_from_address(), LOG, HTTP_Client_Plugin::max_requests, notify_session_monitor(), GNUNET_HELLO_Address::peer, plugin, GNUNET_ATS_Session::plugin, HTTP_Client_Plugin::protocol, GNUNET_ATS_Session::put, res, GNUNET_ATS_Session::scope, HTTP_Client_Plugin::sessions, RequestHandle::state, GNUNET_ATS_Session::timeout, and GNUNET_ATS_Session::timeout_task.

Referenced by libgnunet_plugin_transport_http_client_init().

1999 {
2000  struct HTTP_Client_Plugin *plugin = cls;
2001  struct GNUNET_ATS_Session *s;
2002  struct sockaddr *sa;
2003  enum GNUNET_NetworkType net_type;
2004  size_t salen = 0;
2005  int res;
2006 
2007  GNUNET_assert(NULL != address->address);
2008 
2009  /* find existing session */
2010  s = client_lookup_session(plugin, address);
2011  if (NULL != s)
2012  return s;
2013 
2014  /* create a new session */
2015  if (plugin->max_requests <= plugin->cur_requests)
2016  {
2018  "Maximum number of requests (%u) reached: "
2019  "cannot connect to peer `%s'\n",
2020  plugin->max_requests,
2021  GNUNET_i2s(&address->peer));
2022  return NULL;
2023  }
2024 
2025  /* Determine network location */
2026  net_type = GNUNET_NT_UNSPECIFIED;
2028  address->address_length,
2029  &res);
2030  if (GNUNET_SYSERR == res)
2031  return NULL;
2032  if (GNUNET_YES == res)
2033  {
2034  GNUNET_assert(NULL != sa);
2035  if (AF_INET == sa->sa_family)
2036  {
2037  salen = sizeof(struct sockaddr_in);
2038  }
2039  else if (AF_INET6 == sa->sa_family)
2040  {
2041  salen = sizeof(struct sockaddr_in6);
2042  }
2043  net_type = plugin->env->get_address_type(plugin->env->cls, sa, salen);
2044  GNUNET_free(sa);
2045  }
2046  else if (GNUNET_NO == res)
2047  {
2048  /* Cannot convert to sockaddr -> is external hostname */
2049  net_type = GNUNET_NT_WAN;
2050  }
2051  if (GNUNET_NT_UNSPECIFIED == net_type)
2052  {
2053  GNUNET_break(0);
2054  return NULL;
2055  }
2056 
2057  s = GNUNET_new(struct GNUNET_ATS_Session);
2058  s->plugin = plugin;
2059  s->address = GNUNET_HELLO_address_copy(address);
2060  s->scope = net_type;
2061 
2062  s->put.state = H_NOT_CONNECTED;
2066  s);
2068  "Created new session %p for `%s' address `%s''\n",
2069  s,
2071  s->address->address,
2072  s->address->address_length),
2073  GNUNET_i2s(&s->address->peer));
2074 
2075  /* add new session */
2077  &s->address->peer,
2078  s,
2080  /* initiate new connection */
2081  if (GNUNET_SYSERR == client_connect(s))
2082  {
2084  "Cannot connect to peer `%s' address `%s''\n",
2087  GNUNET_i2s(&s->address->peer));
2089  return NULL;
2090  }
2091  notify_session_monitor(plugin,
2092  s,
2094  notify_session_monitor(plugin,
2095  s,
2096  GNUNET_TRANSPORT_SS_UP); /* or handshake? */
2097  return s;
2098 }
size_t address_length
Number of bytes in address.
#define HTTP_CLIENT_SESSION_TIMEOUT
const void * address
Binary representation of the address (plugin-specific).
struct GNUNET_SCHEDULER_Task * timeout_task
Session timeout task.
struct Plugin * plugin
Pointer to the global plugin struct.
GNUNET_TRANSPORT_AddressToType get_address_type
Function that will be called to figure if an address is an loopback, LAN, WAN etc.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct RequestHandle put
Handle for the HTTP PUT request.
static void client_session_timeout(void *cls)
Session was idle, so disconnect it.
struct GNUNET_TIME_Absolute timeout
When does this session time out.
Wide area network (i.e.
Definition: gnunet_nt_lib.h:54
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_HELLO_Address * address
Address.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
void * cls
Closure for the various callbacks.
static struct GNUNET_ATS_Session * client_lookup_session(struct HTTP_Client_Plugin *plugin, const struct GNUNET_HELLO_Address *address)
Check if a sessions exists for an specific address.
Information about ongoing sessions of the transport client.
int state
The processing state.
static int res
static int client_connect(struct GNUNET_ATS_Session *s)
Connect both PUT and GET request for a session.
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
enum GNUNET_NetworkType scope
ATS network type.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
Just created, not yet connected.
Encapsulation of all of the state of the plugin.
Allow multiple values with the same key.
const char * http_common_plugin_address_to_string(const char *plugin, const void *addr, size_t addrlen)
Function called for a quick conversion of the binary address to a numeric address.
int GNUNET_CONTAINER_multipeermap_put(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct sockaddr * http_common_socket_from_address(const void *addr, size_t addrlen, int *res)
Create a socketaddr from a HTTP address.
unsigned int cur_requests
Current number of sockets the plugin can use Each http connections are two requests.
struct GNUNET_HELLO_Address * GNUNET_HELLO_address_copy(const struct GNUNET_HELLO_Address *address)
Copy an address struct.
Definition: address.c:109
The session was created (first call for each session object).
unsigned int max_requests
Maximum number of sockets the plugin can use Each http connections are two requests.
#define GNUNET_YES
Definition: gnunet_common.h:77
#define LOG(kind,...)
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_free(ptr)
Wrapper around free.
Category of last resort.
Definition: gnunet_nt_lib.h:39
static void client_delete_session(struct GNUNET_ATS_Session *s)
Delete session s.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_start()

static int client_start ( struct HTTP_Client_Plugin plugin)
static

Setup http_client plugin.

Parameters
pluginthe plugin handle
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 2108 of file plugin_transport_http_client.c.

References _, HTTP_Client_Plugin::curl_multi_handle, GNUNET_ERROR_TYPE_ERROR, GNUNET_OK, GNUNET_SYSERR, LOG, and HTTP_Client_Plugin::name.

Referenced by libgnunet_plugin_transport_http_client_init().

2109 {
2110  curl_global_init(CURL_GLOBAL_ALL);
2111  plugin->curl_multi_handle = curl_multi_init();
2112 
2113  if (NULL == plugin->curl_multi_handle)
2114  {
2116  _("Could not initialize curl multi handle, failed to start %s plugin!\n"),
2117  plugin->name);
2118  return GNUNET_SYSERR;
2119  }
2120  return GNUNET_OK;
2121 }
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
CURLM * curl_multi_handle
cURL Multihandle
#define LOG(kind,...)
Here is the caller graph for this function:

◆ http_client_plugin_address_suggested()

static int http_client_plugin_address_suggested ( void *  cls,
const void *  addr,
size_t  addrlen 
)
static

Another peer has suggested an address for this peer and transport plugin.

Check that this could be a valid address. If so, consider adding it to the list of addresses.

Parameters
clsclosure with the struct Plugin
addrpointer to the address
addrlenlength of addr
Returns
GNUNET_OK if this is a plausible address for this peer and transport; always returns GNUNET_NO (this is the client!)

Definition at line 2137 of file plugin_transport_http_client.c.

References GNUNET_NO.

Referenced by libgnunet_plugin_transport_http_client_init().

2140 {
2141  /* A HTTP/S client does not have any valid address so:*/
2142  return GNUNET_NO;
2143 }
#define GNUNET_NO
Definition: gnunet_common.h:78
Here is the caller graph for this function:

◆ libgnunet_plugin_transport_http_client_done()

void* libgnunet_plugin_transport_http_client_done ( void *  cls)

Exit point from the plugin.

Parameters
clsapi as closure
Returns
NULL

Definition at line 2153 of file plugin_transport_http_client.c.

References _, HTTP_Client_Plugin::client_perform_task, GNUNET_TRANSPORT_PluginFunctions::cls, HTTP_Client_Plugin::curl_multi_handle, destroy_session_cb(), GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_free_non_null, GNUNET_SCHEDULER_cancel(), LOG, HTTP_Client_Plugin::name, plugin, HTTP_Client_Plugin::proxy_hostname, HTTP_Client_Plugin::proxy_password, HTTP_Client_Plugin::proxy_username, and HTTP_Client_Plugin::sessions.

2154 {
2155  struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2156  struct HTTP_Client_Plugin *plugin = api->cls;
2157 
2158  if (NULL == api->cls)
2159  {
2160  /* Stub shutdown */
2161  GNUNET_free(api);
2162  return NULL;
2163  }
2165  _("Shutting down plugin `%s'\n"),
2166  plugin->name);
2169  plugin);
2170  if (NULL != plugin->client_perform_task)
2171  {
2173  plugin->client_perform_task = NULL;
2174  }
2175  if (NULL != plugin->curl_multi_handle)
2176  {
2177  curl_multi_cleanup(plugin->curl_multi_handle);
2178  plugin->curl_multi_handle = NULL;
2179  }
2180  curl_global_cleanup();
2182  _("Shutdown for plugin `%s' complete\n"),
2183  plugin->name);
2188  GNUNET_free(plugin);
2189  GNUNET_free(api);
2190  return NULL;
2191 }
char * proxy_username
Username for the proxy server.
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
void GNUNET_CONTAINER_multipeermap_destroy(struct GNUNET_CONTAINER_MultiPeerMap *map)
Destroy a hash map.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void * cls
Closure for all of the callbacks.
static int destroy_session_cb(void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
Callback to destroys all sessions on exit.
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
Encapsulation of all of the state of the plugin.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
struct GNUNET_SCHEDULER_Task * client_perform_task
curl perform task
CURLM * curl_multi_handle
cURL Multihandle
char * proxy_hostname
Proxy configuration: hostname or ip of the proxy server.
#define LOG(kind,...)
char * proxy_password
Password for the proxy server.
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:

◆ client_configure_plugin()

static int client_configure_plugin ( struct HTTP_Client_Plugin plugin)
static

Configure plugin.

Parameters
pluginthe plugin handle
Returns
GNUNET_OK on success, GNUNET_SYSERR on failure

Definition at line 2201 of file plugin_transport_http_client.c.

References _, GNUNET_TRANSPORT_PluginEnvironment::cfg, HTTP_Client_Plugin::emulate_xhr, HTTP_Client_Plugin::env, GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_free_non_null, GNUNET_NO, GNUNET_OK, GNUNET_STRINGS_utf8_toupper(), GNUNET_SYSERR, LOG, HTTP_Client_Plugin::max_requests, HTTP_Client_Plugin::name, HTTP_Client_Plugin::proxy_hostname, HTTP_Client_Plugin::proxy_password, proxy_type, HTTP_Client_Plugin::proxy_use_httpproxytunnel, HTTP_Client_Plugin::proxy_username, and HTTP_Client_Plugin::proxytype.

Referenced by libgnunet_plugin_transport_http_client_init().

2202 {
2203  unsigned long long max_requests;
2204  char *proxy_type;
2205 
2206  /* Optional parameters */
2207  if (GNUNET_OK !=
2209  plugin->name,
2210  "MAX_CONNECTIONS",
2211  &max_requests))
2212  max_requests = 128;
2213  plugin->max_requests = max_requests;
2214 
2216  _("Maximum number of requests is %u\n"),
2217  plugin->max_requests);
2218 
2219  /* Read proxy configuration */
2220  if (GNUNET_OK ==
2222  plugin->name,
2223  "PROXY",
2224  &plugin->proxy_hostname))
2225  {
2227  "Found proxy host: `%s'\n",
2228  plugin->proxy_hostname);
2229  /* proxy username */
2230  if (GNUNET_OK ==
2232  plugin->name,
2233  "PROXY_USERNAME",
2234  &plugin->proxy_username))
2235  {
2237  "Found proxy username name: `%s'\n",
2238  plugin->proxy_username);
2239  }
2240 
2241  /* proxy password */
2242  if (GNUNET_OK ==
2244  plugin->name,
2245  "PROXY_PASSWORD",
2246  &plugin->proxy_password))
2247  {
2249  "Found proxy password name: `%s'\n",
2250  plugin->proxy_password);
2251  }
2252 
2253  /* proxy type */
2254  if (GNUNET_OK ==
2256  plugin->name,
2257  "PROXY_TYPE",
2258  &proxy_type))
2259  {
2260  GNUNET_STRINGS_utf8_toupper(proxy_type, proxy_type);
2261 
2262  if (0 == strcmp(proxy_type, "HTTP"))
2263  plugin->proxytype = CURLPROXY_HTTP;
2264  else if (0 == strcmp(proxy_type, "SOCKS4"))
2265  plugin->proxytype = CURLPROXY_SOCKS4;
2266  else if (0 == strcmp(proxy_type, "SOCKS5"))
2267  plugin->proxytype = CURLPROXY_SOCKS5;
2268  else if (0 == strcmp(proxy_type, "SOCKS4A"))
2269  plugin->proxytype = CURLPROXY_SOCKS4A;
2270  else if (0 == strcmp(proxy_type, "SOCKS5_HOSTNAME "))
2271  plugin->proxytype = CURLPROXY_SOCKS5_HOSTNAME;
2272  else
2273  {
2275  _("Invalid proxy type: `%s', disabling proxy! Check configuration!\n"),
2276  proxy_type);
2277 
2278  GNUNET_free(proxy_type);
2279  GNUNET_free(plugin->proxy_hostname);
2280  plugin->proxy_hostname = NULL;
2282  plugin->proxy_username = NULL;
2284  plugin->proxy_password = NULL;
2285 
2286  return GNUNET_SYSERR;
2287  }
2288 
2290  "Found proxy type: `%s'\n",
2291  proxy_type);
2292  }
2293 
2294  /* proxy http tunneling */
2297  plugin->name,
2298  "PROXY_HTTP_TUNNELING");
2301 
2302  GNUNET_free_non_null(proxy_type);
2303  }
2304 
2305  /* Should we emulate an XHR client for testing? */
2306  plugin->emulate_xhr
2308  plugin->name,
2309  "EMULATE_XHR");
2310  return GNUNET_OK;
2311 }
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
curl_proxytype proxytype
Type of proxy server:
char * proxy_username
Username for the proxy server.
static curl_proxytype proxy_type
Proxy type we are using (can be NULL).
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
int proxy_use_httpproxytunnel
Use proxy tunneling: Tunnel all operations through a given HTTP instead of have the proxy evaluate th...
void GNUNET_STRINGS_utf8_toupper(const char *input, char *output)
Convert the utf-8 input string to upper case.
Definition: strings.c:577
int GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
int emulate_xhr
Should we emulate an XHR client for testing?
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
unsigned int max_requests
Maximum number of sockets the plugin can use Each http connections are two requests.
char * proxy_hostname
Proxy configuration: hostname or ip of the proxy server.
#define LOG(kind,...)
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".
char * proxy_password
Password for the proxy server.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_address_to_string()

static const char* http_client_plugin_address_to_string ( void *  cls,
const void *  addr,
size_t  addrlen 
)
static

Function to convert an address to a human-readable string.

Parameters
clsclosure
addraddress to convert
addrlenaddress length
Returns
res string if conversion was successful, NULL otherwise

Definition at line 2323 of file plugin_transport_http_client.c.

References http_common_plugin_address_to_string(), and PLUGIN_NAME.

Referenced by libgnunet_plugin_transport_http_client_init().

2326 {
2328  addr,
2329  addrlen);
2330 }
const char * http_common_plugin_address_to_string(const char *plugin, const void *addr, size_t addrlen)
Function called for a quick conversion of the binary address to a numeric address.
#define PLUGIN_NAME
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_update_session_timeout()

static void http_client_plugin_update_session_timeout ( void *  cls,
const struct GNUNET_PeerIdentity peer,
struct GNUNET_ATS_Session session 
)
static

Function that will be called whenever the transport service wants to notify the plugin that a session is still active and in use and therefore the session timeout for this session has to be updated.

Parameters
clsclosure
peerwhich peer was the session for
sessionwhich session is being updated

Definition at line 2343 of file plugin_transport_http_client.c.

References client_reschedule_session_timeout().

Referenced by libgnunet_plugin_transport_http_client_init().

2346 {
2348 }
static void client_reschedule_session_timeout(struct GNUNET_ATS_Session *s)
Increment session timeout due to activity for session s.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_update_inbound_delay()

static void http_client_plugin_update_inbound_delay ( void *  cls,
const struct GNUNET_PeerIdentity peer,
struct GNUNET_ATS_Session s,
struct GNUNET_TIME_Relative  delay 
)
static

Function that will be called whenever the transport service wants to notify the plugin that the inbound quota changed and that the plugin should update it's delay for the next receive value.

Parameters
clsclosure
peerwhich peer was the session for
swhich session is being updated
delaynew delay to use for receiving

Definition at line 2362 of file plugin_transport_http_client.c.

References client_wake_up(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_NO, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_cancel(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_relative_to_absolute(), LOG, GNUNET_ATS_Session::next_receive, and GNUNET_ATS_Session::recv_wakeup_task.

Referenced by libgnunet_plugin_transport_http_client_init().

2366 {
2369  "New inbound delay %s\n",
2371  GNUNET_NO));
2372  if (s->recv_wakeup_task != NULL)
2373  {
2375  s->recv_wakeup_task
2377  &client_wake_up,
2378  s);
2379  }
2380 }
struct GNUNET_SCHEDULER_Task * recv_wakeup_task
Task to wake up client receive handle when receiving is allowed again.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
#define GNUNET_NO
Definition: gnunet_common.h:78
static void client_wake_up(void *cls)
Wake up a curl handle which was suspended.
struct GNUNET_TIME_Absolute next_receive
Absolute time when to receive data again Used for receive throttling.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
#define LOG(kind,...)
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ send_session_info_iter()

static int send_session_info_iter ( void *  cls,
const struct GNUNET_PeerIdentity peer,
void *  value 
)
static

Return information about the given session to the monitor callback.

Parameters
clsthe struct Plugin with the monitor callback (sic)
peerpeer we send information about
valueour struct GNUNET_ATS_Session to send information about
Returns
GNUNET_OK (continue to iterate)

Definition at line 2393 of file plugin_transport_http_client.c.

References GNUNET_OK, GNUNET_TRANSPORT_SS_INIT, GNUNET_TRANSPORT_SS_UP, notify_session_monitor(), plugin, and value.

Referenced by http_client_plugin_setup_monitor(), template_plugin_setup_monitor(), and template_plugin_update_session_timeout().

2396 {
2397  struct HTTP_Client_Plugin *plugin = cls;
2398  struct GNUNET_ATS_Session *session = value;
2399 
2400  notify_session_monitor(plugin,
2401  session,
2403  notify_session_monitor(plugin,
2404  session,
2405  GNUNET_TRANSPORT_SS_UP); /* FIXME: or handshake? */
2406  return GNUNET_OK;
2407 }
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
static void notify_session_monitor(struct HTTP_Client_Plugin *plugin, struct GNUNET_ATS_Session *session, enum GNUNET_TRANSPORT_SessionState state)
If a session monitor is attached, notify it about the new session state.
static char * value
Value of the record to add/remove.
Information about ongoing sessions of the transport client.
Encapsulation of all of the state of the plugin.
The session was created (first call for each session object).
Here is the call graph for this function:
Here is the caller graph for this function:

◆ http_client_plugin_setup_monitor()

static void http_client_plugin_setup_monitor ( void *  cls,
GNUNET_TRANSPORT_SessionInfoCallback  sic,
void *  sic_cls 
)
static

Begin monitoring sessions of a plugin.

There can only be one active monitor per plugin (i.e. if there are multiple monitors, the transport service needs to multiplex the generated events over all of them).

Parameters
clsclosure of the plugin
siccallback to invoke, NULL to disable monitor; plugin will being by iterating over all active sessions immediately and then enter monitor mode
sic_clsclosure for sic

Definition at line 2423 of file plugin_transport_http_client.c.

References GNUNET_CONTAINER_multipeermap_iterate(), plugin, send_session_info_iter(), HTTP_Client_Plugin::sessions, HTTP_Client_Plugin::sic, and HTTP_Client_Plugin::sic_cls.

Referenced by libgnunet_plugin_transport_http_client_init().

2426 {
2427  struct HTTP_Client_Plugin *plugin = cls;
2428 
2429  plugin->sic = sic;
2430  plugin->sic_cls = sic_cls;
2431  if (NULL != sic)
2432  {
2435  plugin);
2436  /* signal end of first iteration */
2437  sic(sic_cls, NULL, NULL);
2438  }
2439 }
static int send_session_info_iter(void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
Return information about the given session to the monitor callback.
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
GNUNET_TRANSPORT_SessionInfoCallback sic
Function to call about session status changes.
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
void * sic_cls
Closure for sic.
Encapsulation of all of the state of the plugin.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_transport_http_client_init()

void* libgnunet_plugin_transport_http_client_init ( void *  cls)

Entry point for the plugin.

Definition at line 2446 of file plugin_transport_http_client.c.

References GNUNET_TRANSPORT_PluginFunctions::address_pretty_printer, GNUNET_TRANSPORT_PluginFunctions::address_to_string, GNUNET_TRANSPORT_PluginFunctions::check_address, client_configure_plugin(), client_start(), GNUNET_TRANSPORT_PluginEnvironment::cls, GNUNET_TRANSPORT_PluginFunctions::cls, GNUNET_TRANSPORT_PluginFunctions::disconnect_peer, GNUNET_TRANSPORT_PluginFunctions::disconnect_session, env, HTTP_Client_Plugin::env, GNUNET_TRANSPORT_PluginFunctions::get_network, GNUNET_TRANSPORT_PluginFunctions::get_network_for_address, GNUNET_TRANSPORT_PluginFunctions::get_session, GNUNET_CONTAINER_multipeermap_create(), GNUNET_new, GNUNET_SYSERR, GNUNET_YES, http_client_plugin_address_suggested(), http_client_plugin_address_to_string(), http_client_plugin_get_network(), http_client_plugin_get_network_for_address(), http_client_plugin_get_session(), http_client_plugin_peer_disconnect(), http_client_plugin_send(), http_client_plugin_session_disconnect(), http_client_plugin_setup_monitor(), http_client_plugin_update_inbound_delay(), http_client_plugin_update_session_timeout(), http_client_query_keepalive_factor(), http_common_plugin_address_pretty_printer(), http_common_plugin_string_to_address(), HTTP_Client_Plugin::last_tag, LIBGNUNET_PLUGIN_TRANSPORT_DONE, HTTP_Client_Plugin::name, plugin, HTTP_Client_Plugin::protocol, GNUNET_TRANSPORT_PluginFunctions::query_keepalive_factor, GNUNET_TRANSPORT_PluginEnvironment::receive, GNUNET_TRANSPORT_PluginFunctions::send, HTTP_Client_Plugin::sessions, GNUNET_TRANSPORT_PluginFunctions::setup_monitor, GNUNET_TRANSPORT_PluginFunctions::string_to_address, GNUNET_TRANSPORT_PluginFunctions::update_inbound_delay, and GNUNET_TRANSPORT_PluginFunctions::update_session_timeout.

2447 {
2450  struct HTTP_Client_Plugin *plugin;
2451 
2452  if (NULL == env->receive)
2453  {
2454  /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2455  initialze the plugin or the API */
2457  api->cls = NULL;
2461  return api;
2462  }
2463 
2464  plugin = GNUNET_new(struct HTTP_Client_Plugin);
2465  plugin->env = env;
2467  GNUNET_YES);
2469  api->cls = plugin;
2470  api->send = &http_client_plugin_send;
2484 #if BUILD_HTTPS
2485  plugin->name = "transport-https_client";
2486  plugin->protocol = "https";
2487 #else
2488  plugin->name = "transport-http_client";
2489  plugin->protocol = "http";
2490 #endif
2491  plugin->last_tag = 1;
2492 
2493  if (GNUNET_SYSERR == client_configure_plugin(plugin))
2494  {
2496  return NULL;
2497  }
2498 
2499  /* Start client */
2500  if (GNUNET_SYSERR == client_start(plugin))
2501  {
2503  return NULL;
2504  }
2505  return api;
2506 }
static enum GNUNET_NetworkType http_client_plugin_get_network_for_address(void *cls, const struct GNUNET_HELLO_Address *address)
Function obtain the network type for an address.
static int http_client_plugin_address_suggested(void *cls, const void *addr, size_t addrlen)
Another peer has suggested an address for this peer and transport plugin.
static unsigned int http_client_query_keepalive_factor(void *cls)
Function that is called to get the keepalive factor.
GNUNET_TRANSPORT_CreateSession get_session
Function that will be called tell the plugin to create a session object.
static int http_client_plugin_session_disconnect(void *cls, struct GNUNET_ATS_Session *s)
Disconnect a session.
GNUNET_TRANSPORT_AddressToString address_to_string
Function that will be called to convert a binary address to a string (numeric conversion only)...
static int client_configure_plugin(struct HTTP_Client_Plugin *plugin)
Configure plugin.
uint32_t last_tag
Last used unique HTTP connection tag.
int http_common_plugin_string_to_address(void *cls, const char *addr, uint16_t addrlen, void **buf, size_t *added)
Function called to convert a string address to a binary address.
GNUNET_TRANSPORT_TransmitFunction send
Function that the transport service will use to transmit data to another peer.
GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer
Function that can be used to force the plugin to disconnect from the given peer and cancel all previo...
GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session
Function that can be used to force the plugin to disconnect from the given peer and cancel all previo...
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
GNUNET_TRANSPORT_SessionMonitorSetup setup_monitor
Function to monitor the sessions managed by the plugin.
static void http_client_plugin_update_session_timeout(void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_ATS_Session *session)
Function that will be called whenever the transport service wants to notify the plugin that a session...
static struct GNUNET_ATS_Session * http_client_plugin_get_session(void *cls, const struct GNUNET_HELLO_Address *address)
Creates a new outbound session the transport service will use to send data to the peer...
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_TRANSPORT_PluginEnvironment * env
Our environment.
struct GNUNET_CONTAINER_MultiPeerMap * GNUNET_CONTAINER_multipeermap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
GNUNET_TRANSPORT_PluginReceiveCallback receive
Function that should be called by the transport plugin whenever a message is received.
GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout
Function that will be called whenever the transport service wants to notify the plugin that a session...
static struct GNUNET_ATS_SolverFunctions * plugin
Our solver.
void * cls
Closure for the various callbacks.
void * cls
Closure for all of the callbacks.
GNUNET_TRANSPORT_StringToAddress string_to_address
Function that will be called to convert a string address to binary (numeric conversion only)...
The transport service will pass a pointer to a struct of this type as the first and only argument to ...
GNUNET_TRANSPORT_GetNetworkType get_network
Function to obtain the network type for a session.
void http_common_plugin_address_pretty_printer(void *cls, const char *type, const void *addr, size_t addrlen, int numeric, struct GNUNET_TIME_Relative timeout, GNUNET_TRANSPORT_AddressStringCallback asc, void *asc_cls)
Convert the transports address to a nice, human-readable format.
static ssize_t http_client_plugin_send(void *cls, struct GNUNET_ATS_Session *s, const char *msgbuf, size_t msgbuf_size, unsigned int priority, struct GNUNET_TIME_Relative to, GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
Function that can be used by the transport service to transmit a message using the plugin...
GNUNET_TRANSPORT_UpdateInboundDelay update_inbound_delay
Function that will be called whenever the transport service wants to notify the plugin that the inbou...
static enum GNUNET_NetworkType http_client_plugin_get_network(void *cls, struct GNUNET_ATS_Session *session)
Function obtain the network type for a session.
struct GNUNET_CONTAINER_MultiPeerMap * sessions
Open sessions.
static const char * http_client_plugin_address_to_string(void *cls, const void *addr, size_t addrlen)
Function to convert an address to a human-readable string.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static void http_client_plugin_peer_disconnect(void *cls, const struct GNUNET_PeerIdentity *target)
Function that can be used to force the plugin to disconnect from the given peer and cancel all previo...
#define LIBGNUNET_PLUGIN_TRANSPORT_DONE
Encapsulation of all of the state of the plugin.
GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor
Function that is used to query keepalive factor.
static void http_client_plugin_setup_monitor(void *cls, GNUNET_TRANSPORT_SessionInfoCallback sic, void *sic_cls)
Begin monitoring sessions of a plugin.
static int client_start(struct HTTP_Client_Plugin *plugin)
Setup http_client plugin.
GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer
Function to pretty-print addresses.
#define GNUNET_YES
Definition: gnunet_common.h:77
GNUNET_TRANSPORT_CheckAddress check_address
Function that will be called to check if a binary address for this plugin is well-formed and correspo...
static void http_client_plugin_update_inbound_delay(void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_ATS_Session *s, struct GNUNET_TIME_Relative delay)
Function that will be called whenever the transport service wants to notify the plugin that the inbou...
GNUNET_TRANSPORT_GetNetworkTypeForAddress get_network_for_address
Function to obtain the network type for an address.
Here is the call graph for this function: