libextractor  1.11
About: GNU libextractor is a library used to extract meta-data from files of arbitrary type.
  Fossies Dox: libextractor-1.11.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

EXTRACTOR_PluginList Struct Reference

#include <extractor_plugins.h>

Collaboration diagram for EXTRACTOR_PluginList:
[legend]

Data Fields

struct EXTRACTOR_PluginListnext
 
void * libraryHandle
 
char * libname
 
char * short_libname
 
EXTRACTOR_extract_method extract_method
 
char * plugin_options
 
const char * specials
 
struct EXTRACTOR_Channelchannel
 
struct EXTRACTOR_SharedMemoryshm
 
int64_t seek_request
 
enum EXTRACTOR_Options flags
 
int round_finished
 
uint16_t seek_whence
 

Detailed Description

Linked list of extractor plugins. An application builds this list by telling libextractor to load various meta data extraction plugins. Plugins can also be unloaded (removed from this list, see EXTRACTOR_plugin_remove).

Definition at line 40 of file extractor_plugins.h.

Field Documentation

◆ channel

struct EXTRACTOR_Channel* EXTRACTOR_PluginList::channel

◆ extract_method

EXTRACTOR_extract_method EXTRACTOR_PluginList::extract_method

Pointer to the function used for meta data extraction.

Definition at line 65 of file extractor_plugins.h.

Referenced by do_extract(), EXTRACTOR_plugin_load_(), and handle_start_message().

◆ flags

enum EXTRACTOR_Options EXTRACTOR_PluginList::flags

Flags to control how the plugin is executed.

Definition at line 95 of file extractor_plugins.h.

Referenced by do_extract(), EXTRACTOR_extract(), EXTRACTOR_plugin_add(), EXTRACTOR_plugin_add_config(), and EXTRACTOR_plugin_load_().

◆ libname

char* EXTRACTOR_PluginList::libname

Name of the library (i.e., 'libextractor_foo.so')

Definition at line 55 of file extractor_plugins.h.

Referenced by EXTRACTOR_IPC_channel_recv_(), EXTRACTOR_plugin_add(), EXTRACTOR_plugin_load_(), EXTRACTOR_plugin_remove(), and write_plugin_data().

◆ libraryHandle

void* EXTRACTOR_PluginList::libraryHandle

Pointer to the plugin (as returned by lt_dlopen).

Definition at line 50 of file extractor_plugins.h.

Referenced by EXTRACTOR_plugin_load_(), and EXTRACTOR_plugin_remove().

◆ next

struct EXTRACTOR_PluginList* EXTRACTOR_PluginList::next

This is a linked list.

Definition at line 45 of file extractor_plugins.h.

Referenced by abort_all_channels(), do_extract(), EXTRACTOR_extract(), EXTRACTOR_plugin_add(), and EXTRACTOR_plugin_remove().

◆ plugin_options

char* EXTRACTOR_PluginList::plugin_options

Options for the plugin.

Definition at line 70 of file extractor_plugins.h.

Referenced by do_extract(), EXTRACTOR_plugin_add(), EXTRACTOR_plugin_remove(), handle_start_message(), and write_plugin_data().

◆ round_finished

int EXTRACTOR_PluginList::round_finished

Is this plugin finished extracting for this round? 0: no, 1: yes

Definition at line 106 of file extractor_plugins.h.

Referenced by do_extract(), EXTRACTOR_extract(), EXTRACTOR_IPC_channel_recv_(), EXTRACTOR_IPC_process_reply_(), process_plugin_reply(), send_discard_message(), and send_update_message().

◆ seek_request

int64_t EXTRACTOR_PluginList::seek_request

A position this plugin wants us to seek to. -1 if it's finished. A positive value from the end of the file is used of 'whence' is SEEK_END; a postive value from the start is used of 'whence' is SEEK_SET. 'SEEK_CUR' is never used.

Definition at line 95 of file extractor_plugins.h.

Referenced by do_extract(), EXTRACTOR_IPC_channel_recv_(), EXTRACTOR_IPC_process_reply_(), and EXTRACTOR_plugin_add().

◆ seek_whence

uint16_t EXTRACTOR_PluginList::seek_whence

'whence' value for the seek operation; 0 = SEEK_SET, 1 = SEEK_CUR, 2 = SEEK_END. Note that 'SEEK_CUR' is never used here.

Definition at line 113 of file extractor_plugins.h.

Referenced by do_extract(), and EXTRACTOR_IPC_process_reply_().

◆ shm

struct EXTRACTOR_SharedMemory* EXTRACTOR_PluginList::shm

Memory segment shared with the channel of this plugin, NULL for none.

Definition at line 87 of file extractor_plugins.h.

Referenced by EXTRACTOR_extract(), and EXTRACTOR_plugin_remove().

◆ short_libname

char* EXTRACTOR_PluginList::short_libname

◆ specials

const char* EXTRACTOR_PluginList::specials

Special options for the plugin (as returned by the plugin's "options" method; typically NULL).

Definition at line 77 of file extractor_plugins.h.

Referenced by EXTRACTOR_plugin_load_(), EXTRACTOR_plugin_main_(), and handle_start_message().


The documentation for this struct was generated from the following file: