plugins_int.h File Reference

#include "plugins.h"
#include "plugin_idb_int.h"
#include "plugin_pktb_int.h"
#include "plugin_spb_int.h"

Go to the source code of this file.

Typedefs

typedef _ntar_data_chunk ntar_data_chunk

Element of a list representing a generic blob (block of bytes) that have to be written to a trace file, or have been read out of it.

typedef int(* plugin_init )(void **plugin_state)

Initializes a given plugin state.

typedef int(* plugin_destroy )(void *plugin_state)

Destroys a given plugin state.

typedef int(* plugin_write_data )(void *plugin_state, void *data, void *data_buffer, size_t *pbuffer_size)

Formats the data of a block in order to be written to some storage.

typedef int(* plugin_write_option )(void *plugin_state, ntar_option *option, void *opt_buffer, size_t *pbuffer_size)

Formats the option data of a block option in order to be written to some storage.

typedef int(* plugin_validate_option )(void *plugin_state, ntar_option *option)

Verifies that a given option is compatible with a given block.

typedef int(* plugin_read_data )(void *plugin_state, int byte_order, void *raw_data, size_t raw_data_size, void **data_buffer, size_t *pbuffer_size, size_t *poption_start)

This function should decode the data of a block to a library provided memory buffer.

typedef int(* plugin_read_option )(void *plugin_state, option_header *opt_header, int byte_order, void *opt_buffer, size_t *pbuffer_size)

This function should decode the option data of a block to a library provided memory buffer.

typedef _ntar_plugin_data ntar_plugin_data

This structure is used to uniquely identify a given plugin. It contains the unique identifier of a block, as well as all the pointers to the plugin callbacks.

Functions

ntar_plugin_data * get_plugin_data (u_int32 block_id)

This function returns a pointer to a ntar_plugin_data structure uniquely identifying the callbacks of a given block.

Variables

ntar_plugin_data ntar_plugins []


Typedefs
typedef _ntar_data_chunk	ntar_data_chunk
	Element of a list representing a generic blob (block of bytes) that have to be written to a trace file, or have been read out of it.
typedef int(*	plugin_init )(void **plugin_state)
	Initializes a given plugin state.
typedef int(*	plugin_destroy )(void *plugin_state)
	Destroys a given plugin state.
typedef int(*	plugin_write_data )(void plugin_state, void data, void data_buffer, size_t pbuffer_size)
	Formats the data of a block in order to be written to some storage.
typedef int(*	plugin_write_option )(void plugin_state, ntar_option option, void opt_buffer, size_t pbuffer_size)
	Formats the option data of a block option in order to be written to some storage.
typedef int(*	plugin_validate_option )(void plugin_state, ntar_option option)
	Verifies that a given option is compatible with a given block.
typedef int(*	plugin_read_data )(void plugin_state, int byte_order, void raw_data, size_t raw_data_size, void *data_buffer, size_t pbuffer_size, size_t *poption_start)
	This function should decode the data of a block to a library provided memory buffer.
typedef int(*	plugin_read_option )(void plugin_state, option_header opt_header, int byte_order, void opt_buffer, size_t pbuffer_size)
	This function should decode the option data of a block to a library provided memory buffer.
typedef _ntar_plugin_data	ntar_plugin_data
	This structure is used to uniquely identify a given plugin. It contains the unique identifier of a block, as well as all the pointers to the plugin callbacks.
Functions
ntar_plugin_data *	get_plugin_data (u_int32 block_id)
	This function returns a pointer to a ntar_plugin_data structure uniquely identifying the callbacks of a given block.
Variables
ntar_plugin_data	ntar_plugins []