copying_plugin.c File Reference

#include "platform.h"
#include "gnunet_rest_plugin.h"
#include <gnunet_rest_lib.h>

Include dependency graph for copying_plugin.c:

Go to the source code of this file.

Data Structures
struct	Plugin
	Handle for a plugin. More...
struct	RequestHandle
	The request handle. More...

Macros
#define	GNUNET_REST_API_NS_COPYING   "/copying"
#define	GNUNET_REST_COPYING_TEXT    "GNU Affero General Public License version 3 or later. See also: <http://www.gnu.org/licenses/>"

Functions
static void	cleanup_handle (struct RequestHandle *handle)
	Cleanup request handle. More...
static void	get_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
	Handle rest request. More...
static void	options_cont (struct GNUNET_REST_RequestHandle *con_handle, const char *url, void *cls)
	Handle rest request. More...
enum GNUNET_GenericReturnValue	REST_copying_process_request (void *plugin, struct GNUNET_REST_RequestHandle *conndata_handle, GNUNET_REST_ResultProcessor proc, void *proc_cls)
	Function processing the REST call. More...
void *	REST_copying_init (const struct GNUNET_CONFIGURATION_Handle *c)
	Entry point for the plugin. More...
void	REST_copying_done (struct GNUNET_REST_Plugin *api)
	Exit point from the plugin. More...

Variables
static struct RequestHandle *	requests_head
	DLL. More...
static struct RequestHandle *	requests_tail
	DLL. More...

Macro Definition Documentation

GNUNET_REST_API_NS_COPYING

#define GNUNET_REST_API_NS_COPYING   "/copying"

Definition at line 31 of file copying_plugin.c.

GNUNET_REST_COPYING_TEXT

#define GNUNET_REST_COPYING_TEXT    "GNU Affero General Public License version 3 or later. See also: <http://www.gnu.org/licenses/>"

Definition at line 33 of file copying_plugin.c.

Function Documentation

cleanup_handle()

static void cleanup_handle ( struct RequestHandle *  handle )

static

Cleanup request handle.

Parameters

handle

Handle to clean up

Definition at line 93 of file copying_plugin.c.

{
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Cleaning up\n");
  GNUNET_CONTAINER_DLL_remove (requests_head,
                               requests_tail,
                               handle);
  GNUNET_free (handle);
}

References GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, handle, requests_head, and requests_tail.

Referenced by get_cont(), options_cont(), and REST_copying_done().

Here is the caller graph for this function:

get_cont()

static void get_cont ( struct GNUNET_REST_RequestHandle *  con_handle, const char *  url, void *  cls  )

static

Handle rest request.

Parameters

handle

the lookup handle

Definition at line 110 of file copying_plugin.c.

{
  struct MHD_Response *resp;
  struct RequestHandle *handle = cls;
 
  resp = GNUNET_REST_create_response (GNUNET_REST_COPYING_TEXT);
  handle->proc (handle->proc_cls,
                resp,
                MHD_HTTP_OK);
  cleanup_handle (handle);
}

References cleanup_handle(), GNUNET_REST_COPYING_TEXT, GNUNET_REST_create_response(), handle, and MHD_HTTP_OK.

Referenced by REST_copying_process_request().

Here is the call graph for this function:

Here is the caller graph for this function:

options_cont()

static void options_cont ( struct GNUNET_REST_RequestHandle *  con_handle, const char *  url, void *  cls  )

static

Handle rest request.

Parameters

handle

the lookup handle

Definition at line 131 of file copying_plugin.c.

{
  struct MHD_Response *resp;
  struct RequestHandle *handle = cls;
 
  resp = GNUNET_REST_create_response (NULL);
  GNUNET_assert (MHD_NO != MHD_add_response_header (resp,
                                                    "Access-Control-Allow-Methods",
                                                    MHD_HTTP_METHOD_GET));
  handle->proc (handle->proc_cls,
                resp,
                MHD_HTTP_OK);
  cleanup_handle (handle);
}

References cleanup_handle(), GNUNET_assert, GNUNET_REST_create_response(), handle, and MHD_HTTP_OK.

Referenced by REST_copying_process_request().

Here is the call graph for this function:

Here is the caller graph for this function:

REST_copying_process_request()

enum GNUNET_GenericReturnValue REST_copying_process_request	(	void *	plugin,
		struct GNUNET_REST_RequestHandle *	conndata_handle,
		GNUNET_REST_ResultProcessor	proc,
		void *	proc_cls
	)

Function processing the REST call.

Parameters

method	HTTP method
url	URL of the HTTP request
data	body of the HTTP request (optional)
data_size	length of the body
proc	callback function for the result
proc_cls	closure for proc

Returns

GNUNET_OK if request accepted

Definition at line 161 of file copying_plugin.c.

{
  static const struct GNUNET_REST_RequestHandler handlers[] = {
    { MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_COPYING, &get_cont },
    { MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_COPYING, &options_cont },
    GNUNET_REST_HANDLER_END
  };
  struct RequestHandle *handle = GNUNET_new (struct RequestHandle);
  struct GNUNET_REST_RequestHandlerError err;
 
  handle->proc_cls = proc_cls;
  handle->proc = proc;
  handle->rest_handle = conndata_handle;
  GNUNET_CONTAINER_DLL_insert (requests_head,
                               requests_tail,
                               handle);
  return GNUNET_REST_handle_request (conndata_handle,
                                     handlers,
                                     &err,
                                     handle);
}

References get_cont(), GNUNET_CONTAINER_DLL_insert, GNUNET_new, GNUNET_REST_API_NS_COPYING, GNUNET_REST_handle_request(), GNUNET_REST_HANDLER_END, handle, handlers, options_cont(), requests_head, and requests_tail.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

REST_copying_init()

void * REST_copying_init

(

const struct GNUNET_CONFIGURATION_Handle *

c

)

Entry point for the plugin.

Parameters

cls	the "struct GNUNET_NAMESTORE_PluginEnvironment*"

Returns

NULL on error, otherwise the plugin context

Definition at line 194 of file copying_plugin.c.

{
  static struct Plugin plugin;
 
  struct GNUNET_REST_Plugin *api;
 
  if (NULL != plugin.cfg)
    return NULL;                /* can only initialize once! */
  memset (&plugin, 0, sizeof(struct Plugin));
  plugin.cfg = c;
  api = GNUNET_new (struct GNUNET_REST_Plugin);
  api->cls = &plugin;
  api->name = GNUNET_REST_API_NS_COPYING;
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              _ ("COPYING REST API initialized\n"));
  return api;
}

References _, GNUNET_REST_Plugin::cls, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_new, GNUNET_REST_API_NS_COPYING, GNUNET_REST_Plugin::name, and plugin.

Referenced by run().

Here is the caller graph for this function:

REST_copying_done()

void REST_copying_done

(

struct GNUNET_REST_Plugin *

api

)

Exit point from the plugin.

Parameters

cls	the plugin context (as returned by "init")

Returns

always NULL

Definition at line 220 of file copying_plugin.c.

{
  struct Plugin *plugin = api->cls;
 
  while (NULL != requests_head)
    cleanup_handle (requests_head);
  plugin->cfg = NULL;
  GNUNET_free (api);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "COPYING REST plugin is finished\n");
}

References Plugin::api, cleanup_handle(), GNUNET_BLOCK_PluginFunctions::cls, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, plugin, and requests_head.

Referenced by do_shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

requests_head

struct RequestHandle* requests_head

static

DLL.

Definition at line 80 of file copying_plugin.c.

Referenced by cleanup_handle(), REST_copying_done(), and REST_copying_process_request().

requests_tail

struct RequestHandle* requests_tail

static

DLL.

Definition at line 85 of file copying_plugin.c.

Referenced by cleanup_handle(), and REST_copying_process_request().