handler.h File Reference

#include <stddef.h>
#include <time.h>
#include "typedefs.h"
#include "grassroots_handler_library.h"
#include "plugin.h"
#include "data_resource.h"
#include "parameter.h"
#include "jansson.h"
#include "filesystem_utils.h"
#include "user_details.h"

Include dependency graph for handler.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Handler
	A Handler is a datatype for accessing data. More...
struct	HandlerNode
	A datatype for storing a Handler on a LinkedList. More...

Enumerations
enum	HandlerStatus { HS_GOOD, HS_FINISHED, HS_BAD, HS_NONE }
	An enumeration of the possible status values of a stream being used by a Handler. More...

Functions
Handler *	GetHandlerFromPlugin (Plugin *const plugin_p, const User *user_p, struct GrassrootsServer *grassroots_p)
	Load a Handler from a Plugin. More...
bool	DeallocatePluginHandler (Plugin *const plugin_p)
	Free the Plugin associated with a Handler. More...
struct GrassrootsServer *	GetGrassrootsServerFromHandler (const Handler *const handler_p)

Function Documentation

GetHandlerFromPlugin()

Handler* GetHandlerFromPlugin	(	Plugin *const	plugin_p,
		const User *	user_p,
		struct GrassrootsServer *	grassroots_p
	)

Load a Handler from a Plugin.

Parameters

plugin_p	The Plugin to load the Handler from.
user_p	An optional UserDetails for the user. This can be NULL.

Returns

The Handler or NULL if one could not be loaded successfully.

DeallocatePluginHandler()

bool DeallocatePluginHandler

(

Plugin *const

plugin_p

)

Free the Plugin associated with a Handler.

Parameters

plugin_p

The Plugin to free.

Returns

true upon success, false upon failure.

GetGrassrootsServerFromHandler()

struct GrassrootsServer* GetGrassrootsServerFromHandler

(

const Handler *const

handler_p

)