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_Channel Struct Reference
Collaboration diagram for EXTRACTOR_Channel:
[legend]

Data Fields

char * mdata
 
size_t mdata_size
 
struct EXTRACTOR_SharedMemoryshm
 
struct EXTRACTOR_PluginListplugin
 
int cpipe_in
 
size_t size
 
int cpipe_out
 
pid_t cpid
 
HANDLE hProcess
 
HANDLE cpipe_in
 
HANDLE map_handle
 
HANDLE cpipe_out
 
OVERLAPPED ov_read
 
OVERLAPPED ov_write
 
unsigned char * ov_write_buffer
 
void * old_buf
 

Detailed Description

Definition of an IPC communication channel with some plugin.

Definition at line 79 of file extractor_ipc_gnu.c.

Field Documentation

◆ cpid

pid_t EXTRACTOR_Channel::cpid

Process ID of the child process for this plugin. 0 for none.

Definition at line 122 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), and EXTRACTOR_IPC_channel_destroy_().

◆ cpipe_in [1/2]

int EXTRACTOR_Channel::cpipe_in

Pipe used to communicate information to the plugin child process. NULL if not initialized.

Definition at line 106 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_send_().

◆ cpipe_in [2/2]

HANDLE EXTRACTOR_Channel::cpipe_in

Pipe used to communicate information to the plugin child process. NULL if not initialized.

Definition at line 90 of file extractor_ipc_w32.c.

◆ cpipe_out [1/2]

int EXTRACTOR_Channel::cpipe_out

Pipe used to read information about extracted meta data from the plugin child process. -1 if not initialized.

Definition at line 117 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_recv_().

◆ cpipe_out [2/2]

HANDLE EXTRACTOR_Channel::cpipe_out

Pipe used to read information about extracted meta data from the plugin child process. -1 if not initialized.

Definition at line 101 of file extractor_ipc_w32.c.

◆ hProcess

HANDLE EXTRACTOR_Channel::hProcess

Process ID of the child process for this plugin. 0 for none.

Definition at line 84 of file extractor_ipc_w32.c.

Referenced by EXTRACTOR_IPC_channel_create_(), and EXTRACTOR_IPC_channel_destroy_().

◆ map_handle

HANDLE EXTRACTOR_Channel::map_handle

Handle of the shm object

Definition at line 95 of file extractor_ipc_w32.c.

◆ mdata

char * EXTRACTOR_Channel::mdata

Buffer for reading data from the plugin.

Definition at line 85 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_recv_().

◆ mdata_size

size_t EXTRACTOR_Channel::mdata_size

Size of the mdata buffer.

Size of the 'mdata' buffer.

Definition at line 90 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), and EXTRACTOR_IPC_channel_recv_().

◆ old_buf

void* EXTRACTOR_Channel::old_buf

Definition at line 128 of file extractor_ipc_w32.c.

Referenced by EXTRACTOR_IPC_channel_send_().

◆ ov_read

OVERLAPPED EXTRACTOR_Channel::ov_read

A structure for overlapped reads on W32.

Definition at line 106 of file extractor_ipc_w32.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_recv_().

◆ ov_write

OVERLAPPED EXTRACTOR_Channel::ov_write

A structure for overlapped writes on W32.

Definition at line 111 of file extractor_ipc_w32.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_send_().

◆ ov_write_buffer

unsigned char* EXTRACTOR_Channel::ov_write_buffer

A write buffer for overlapped writes on W32

Definition at line 116 of file extractor_ipc_w32.c.

Referenced by EXTRACTOR_IPC_channel_create_(), and EXTRACTOR_IPC_channel_destroy_().

◆ plugin

struct EXTRACTOR_PluginList * EXTRACTOR_Channel::plugin

The plugin this channel is to communicate with.

Definition at line 100 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), EXTRACTOR_IPC_channel_destroy_(), and EXTRACTOR_IPC_channel_recv_().

◆ shm

struct EXTRACTOR_SharedMemory * EXTRACTOR_Channel::shm

Memory segment shared with this process.

Definition at line 95 of file extractor_ipc_gnu.c.

Referenced by do_extract(), and EXTRACTOR_IPC_channel_create_().

◆ size

size_t EXTRACTOR_Channel::size

Number of valid bytes in the channel's buffer.

Definition at line 111 of file extractor_ipc_gnu.c.

Referenced by EXTRACTOR_IPC_channel_create_(), and EXTRACTOR_IPC_channel_recv_().


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