plugin.h File Reference

Plugin interface description. More...

#include "msint.h"
#include "stmt/simplelist.h"
#include "stmt/statement.h"

Include dependency graph for plugin.h:

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

Go to the source code of this file.

Data Structures
struct	_MSInterface
	Interface of ModelStorage functionality for plugin. More...
struct	_MSPlugin
	The struct, each plugin should fill. More...
struct	_PluginArg
	Argument for implement function. More...
struct	_PluginFunc
	Plugin function structure. More...
Defines
#define	PLUGIN_STORAGE_TYPE   extern
Typedefs
typedef _MSInstance	MSInstance
typedef _MSInterface	MSInterface
typedef _MSPlugin	MSPlugin
	Forward declarations.
typedef _PluginArg	PluginArg
	Argument for implement function.
typedef _PluginFunc	PluginFunc
typedef _StmtList	StmtList
Enumerations
enum	PluginFuncType {   PLUGIN_TYPE_SETRULE, PLUGIN_TYPE_GETRULE, PLUGIN_TYPE_GETGENRULE, PLUGIN_TYPE_GETFILRULE,   PLUGIN_TYPE_IFUNCTION, PLUGIN_TYPE_BEFORESETRULE, PLUGIN_TYPE_AFTERSETRULE, PLUGIN_TYPE_GETPOSTRULE,   PLUGIN_TYPE_AFTERRESTORERULE }
	Plugin function type enumeration. More...
enum	PluginResp { PLUGIN_RESP_CONTINUE, PLUGIN_RESP_STOP, PLUGIN_RESP_BLOCK }
	Plugin function responses. More...
Functions
PLUGIN_STORAGE_TYPE MSPlugin	plug_initialize (void)
	Main function each plugin should implement.

---

Detailed Description

Plugin interface description.

---

Define Documentation

#define PLUGIN_STORAGE_TYPE   extern

---

Typedef Documentation

typedef struct _MSInstance MSInstance

typedef struct _MSInterface MSInterface

typedef struct _MSPlugin MSPlugin

Forward declarations.

typedef struct _PluginArg PluginArg

Argument for implement function.

typedef struct _PluginFunc PluginFunc

typedef struct _StmtList StmtList

---

Enumeration Type Documentation

enum PluginFuncType

Plugin function type enumeration. Enumerator: PLUGIN_TYPE_SETRULE  The type of plugin function is Set-rule. Deprecated: Analogous to PLUGIN_TYPE_BEFORESETRULE PLUGIN_TYPE_GETRULE  The type of plugin function is Get-rule. Deprecated: Use PLUGIN_TYPE_GETGENRULE PLUGIN_TYPE_GETGENRULE  The type of plugin function is GetGen rule This type of functions are called before executing any get query through model_storage_get call. PLUGIN_TYPE_GETFILRULE  The type of plugin function is GetFilt rule. Deprecated: Use PLUGIN_TYPE_GETPOSTRULE PLUGIN_TYPE_IFUNCTION  The type of plugin function is Internal Function. PLUGIN_TYPE_BEFORESETRULE  The type of plugin function is before-set rule. PLUGIN_TYPE_AFTERSETRULE  The type of plugin function is after-set rule. PLUGIN_TYPE_GETPOSTRULE  The type of plugin function is get-postprocess rule. PLUGIN_TYPE_AFTERRESTORERULE  The type of plugin function is after-restore rule.

enum PluginResp

Plugin function responses. Enumerator: PLUGIN_RESP_CONTINUE  Continue. PLUGIN_RESP_STOP  Stop rule processing. PLUGIN_RESP_BLOCK  Stop rule processing and block query execution.

---

Function Documentation

PLUGIN_STORAGE_TYPE MSPlugin plug_initialize (  void   )

Main function each plugin should implement.

---