/*
This file is part of GNUnet
- (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @brief http transport service plugin
* @author Matthias Wachs
*/
+#ifndef PLUGIN_TRANSPORT_HTTP_H
+#define PLUGIN_TRANSPORT_HTTP_H
#include "platform.h"
#include "gnunet_common.h"
*/
struct Plugin
{
- /**
- * General handles
- * ---------------
- */
-
/**
* Our environment.
*/
struct GNUNET_TRANSPORT_PluginEnvironment *env;
/**
- * Linked list of open sessions.
+ * Head of linked list of open sessions.
*/
-
struct Session *head;
+ /**
+ * Tail of linked list of open sessions.
+ */
struct Session *tail;
/**
struct GNUNET_NAT_Handle *nat;
/**
- * List of own addresses
- */
-
- /**
- * IPv4 addresses DLL head
- */
- struct IPv4HttpAddressWrapper *ipv4_addr_head;
-
- /**
- * IPv4 addresses DLL tail
- */
- struct IPv4HttpAddressWrapper *ipv4_addr_tail;
-
- /**
- * IPv6 addresses DLL head
- */
- struct IPv6HttpAddressWrapper *ipv6_addr_head;
-
- /**
- * IPv6 addresses DLL tail
+ * Our own IPv4 addresses DLL head
*/
- struct IPv6HttpAddressWrapper *ipv6_addr_tail;
+ struct HttpAddressWrapper *addr_head;
/**
- * Plugin configuration
- * --------------------
+ * Our own IPv4 addresses DLL tail
*/
+ struct HttpAddressWrapper *addr_tail;
/**
* External hostname the plugin can be connected to, can be different to
/**
* Task calling transport service about external address
*/
- GNUNET_SCHEDULER_TaskIdentifier notify_ext_task;
-
+ struct GNUNET_SCHEDULER_Task * notify_ext_task;
/**
- * Plugin name
+ * Plugin name.
* Equals configuration section: transport-http, transport-https
*/
char *name;
char *protocol;
/**
- * Use IPv4?
- * GNUNET_YES or GNUNET_NO
+ * Use IPv4? #GNUNET_YES or #GNUNET_NO
*/
int ipv4;
/**
- * Use IPv6?
- * GNUNET_YES or GNUNET_NO
+ * Use IPv6? #GNUNET_YES or #GNUNET_NO
*/
int ipv6;
/**
* Does plugin just use outbound connections and not accept inbound?
*/
-
int client_only;
/**
*/
unsigned int inbound_sessions;
- /**
- * Plugin HTTPS SSL/TLS options
- * ----------------------------
- */
-
/**
* libCurl TLS crypto init string, can be set to enhance performance
*
*
* Use RC4-128 instead of AES:
* NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
- *
*/
char *crypto_init;
*/
char *cert;
- /**
- * Plugin values
- * -------------
- */
-
/**
* Current number of establishes connections
*/
*/
uint32_t last_tag;
- /**
- * Server handles
- * --------------
- */
-
/**
* MHD IPv4 daemon
*/
/**
* MHD IPv4 task
*/
- GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
+ struct GNUNET_SCHEDULER_Task * server_v4_task;
/**
* The IPv4 server is scheduled to run asap
/**
* MHD IPv4 task
*/
- GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
+ struct GNUNET_SCHEDULER_Task * server_v6_task;
/**
* The IPv6 server is scheduled to run asap
*/
-
int server_v6_immediately;
/**
struct sockaddr_in6 *server_addr_v6;
/**
- * Server semi connections
+ * Head of server semi connections
* A full session consists of 2 semi-connections: send and receive
* If not both directions are established the server keeps this sessions here
*/
struct Session *server_semi_head;
- struct Session *server_semi_tail;
-
- /*
- * Client handles
+ /**
+ * Tail of server semi connections
+ * A full session consists of 2 semi-connections: send and receive
+ * If not both directions are established the server keeps this sessions here
*/
+ struct Session *server_semi_tail;
/**
* cURL Multihandle
/**
* curl perform task
*/
- GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
+ struct GNUNET_SCHEDULER_Task * client_perform_task;
};
GNUNET_NETWORK_STRUCT_END
-struct ServerConnection
+struct ServerRequest
{
- /* _RECV or _SEND */
+ /**
+ * _RECV or _SEND
+ */
int direction;
- /* Should this connection get disconnected? GNUNET_YES/NO */
+ /**
+ * Should this connection get disconnected? #GNUNET_YES / #GNUNET_NO
+ */
int disconnect;
- /* The session this server connection belongs to */
+ /**
+ * The session this server connection belongs to
+ */
struct Session *session;
- /* The MHD connection */
+ /**
+ * The MHD connection
+ */
struct MHD_Connection *mhd_conn;
};
-
/**
* Session handle for connections.
*/
*/
struct HTTP_Message *msg_tail;
-
/**
* Message stream tokenizer for incoming data
*/
/**
* Inbound or outbound connection
- * Outbound: GNUNET_NO (client is used to send and receive)
- * Inbound : GNUNET_YES (server is used to send and receive)
+ * Outbound: #GNUNET_NO (client is used to send and receive)
+ * Inbound : #GNUNET_YES (server is used to send and receive)
*/
int inbound;
*/
uint32_t tag;
- /**
- * Client handles
- */
-
/**
* Client send handle
*/
/**
* Task to wake up client receive handle when receiving is allowed again
*/
- GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
+ struct GNUNET_SCHEDULER_Task * recv_wakeup_task;
/**
* Session timeout task
*/
- GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+ struct GNUNET_SCHEDULER_Task * timeout_task;
/**
* Is client send handle paused since there are no data to send?
- * GNUNET_YES/NO
+ * #GNUNET_YES or #GNUNET_NO
*/
int client_put_paused;
- /**
- * Server handles
- */
-
/**
* Client send handle
*/
- struct ServerConnection *server_recv;
+ struct ServerRequest *server_recv;
/**
* Client send handle
*/
- struct ServerConnection *server_send;
+ struct ServerRequest *server_send;
};
+
/**
* Message to send using http
*/
GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
/**
- * Closure for transmit_cont.
+ * Closure for @e transmit_cont.
*/
void *transmit_cont_cls;
};
+
struct Session *
-create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
- const void *addr, size_t addrlen);
+create_session (struct Plugin *plugin,
+ const struct GNUNET_PeerIdentity *target,
+ const void *addr,
+ size_t addrlen);
+
int
-exist_session (struct Plugin *plugin, struct Session *s);
+exist_session (struct Plugin *plugin,
+ struct Session *s);
+
void
delete_session (struct Session *s);
+
int
-exist_session (struct Plugin *plugin, struct Session *s);
+exist_session (struct Plugin *plugin,
+ struct Session *s);
+
struct GNUNET_TIME_Relative
-http_plugin_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
+http_plugin_receive (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_MessageHeader *message,
- struct Session *session, const char *sender_address,
+ struct Session *session,
+ const char *sender_address,
uint16_t sender_address_len);
+
const char *
-http_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
+http_plugin_address_to_string (void *cls,
+ const void *addr,
+ size_t addrlen);
+
int
client_disconnect (struct Session *s);
+
int
client_connect (struct Session *s);
+
int
client_send (struct Session *s, struct HTTP_Message *msg);
+
int
client_start (struct Plugin *plugin);
+
void
client_stop (struct Plugin *plugin);
+
int
server_disconnect (struct Session *s);
+
int
server_send (struct Session *s, struct HTTP_Message *msg);
+
int
server_start (struct Plugin *plugin);
+
void
server_stop (struct Plugin *plugin);
+
void
-notify_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
+notify_session_end (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
struct Session *s);
+
+/*#ifndef PLUGIN_TRANSPORT_HTTP_H*/
+#endif
/* end of plugin_transport_http.h */