Libtrap: Internal development docs  1.16.1
Data Fields
trap_input_ifc_s Struct Reference

#include <trap_ifc.h>

Data Fields

ifc_is_conn_func_t is_conn
 Pointer to is_connected function. More...
 
ifc_get_id_func_t get_id
 Pointer to get_id function. More...
 
ifc_recv_func_t recv
 Pointer to receive function. More...
 
ifc_terminate_func_t terminate
 Pointer to terminate function. More...
 
ifc_destroy_func_t destroy
 Pointer to destructor function. More...
 
ifc_create_dump_func_t create_dump
 Pointer to function for generating of dump. More...
 
void * priv
 Pointer to instance's private data. More...
 
char * buffer
 Internal pointer to buffer for messages. More...
 
char * buffer_pointer
 Internal pointer to current message in buffer. More...
 
uint32_t buffer_unread_bytes
 Number of unread bytes in buffer. More...
 
int32_t datatimeout
 Timeout for *_recv() calls. More...
 
char ifc_type
 Type of interface. More...
 
pthread_mutex_t ifc_mtx
 Locking mutex for interface. More...
 
char datatimeout_fixed
 
trap_in_ifc_state_t client_state
 
uint8_t data_type
 
char * data_fmt_spec
 
uint8_t req_data_type
 
char * req_data_fmt_spec
 

Detailed Description

Struct to hold an instance of some input interface.

Definition at line 180 of file trap_ifc.h.

Field Documentation

◆ buffer

char* trap_input_ifc_s::buffer

Internal pointer to buffer for messages.

Definition at line 188 of file trap_ifc.h.

◆ buffer_pointer

char* trap_input_ifc_s::buffer_pointer

Internal pointer to current message in buffer.

Definition at line 189 of file trap_ifc.h.

◆ buffer_unread_bytes

uint32_t trap_input_ifc_s::buffer_unread_bytes

Number of unread bytes in buffer.

Definition at line 190 of file trap_ifc.h.

◆ client_state

trap_in_ifc_state_t trap_input_ifc_s::client_state

Negotiation state defined as trap_in_ifc_state_t.

Definition at line 205 of file trap_ifc.h.

◆ create_dump

ifc_create_dump_func_t trap_input_ifc_s::create_dump

Pointer to function for generating of dump.

Definition at line 186 of file trap_ifc.h.

◆ data_fmt_spec

char* trap_input_ifc_s::data_fmt_spec

Message format specifier.

if data_type is TRAP_FMT_RAW, no data_fmt_spec is expected. Otherwise, data_fmt_spec contains e.g. UniRec template specifier (string representation)

Definition at line 218 of file trap_ifc.h.

◆ data_type

uint8_t trap_input_ifc_s::data_type

Message format defined by trap_data_format_t.

Definition at line 210 of file trap_ifc.h.

◆ datatimeout

int32_t trap_input_ifc_s::datatimeout

Timeout for *_recv() calls.

Definition at line 191 of file trap_ifc.h.

◆ datatimeout_fixed

char trap_input_ifc_s::datatimeout_fixed

If 1 do not allow to change timeout by module, it is used to force timeout of IFC by module's parameter. If 0 - timeout can be changed by standard way using trap_ctx_ifcctl().

Definition at line 200 of file trap_ifc.h.

◆ destroy

ifc_destroy_func_t trap_input_ifc_s::destroy

Pointer to destructor function.

Definition at line 185 of file trap_ifc.h.

◆ get_id

ifc_get_id_func_t trap_input_ifc_s::get_id

Pointer to get_id function.

Definition at line 182 of file trap_ifc.h.

◆ ifc_mtx

pthread_mutex_t trap_input_ifc_s::ifc_mtx

Locking mutex for interface.

Definition at line 193 of file trap_ifc.h.

◆ ifc_type

char trap_input_ifc_s::ifc_type

Type of interface.

Definition at line 192 of file trap_ifc.h.

◆ is_conn

ifc_is_conn_func_t trap_input_ifc_s::is_conn

Pointer to is_connected function.

Definition at line 181 of file trap_ifc.h.

◆ priv

void* trap_input_ifc_s::priv

Pointer to instance's private data.

Definition at line 187 of file trap_ifc.h.

◆ recv

ifc_recv_func_t trap_input_ifc_s::recv

Pointer to receive function.

Definition at line 183 of file trap_ifc.h.

◆ req_data_fmt_spec

char* trap_input_ifc_s::req_data_fmt_spec

Required message format specifier.

if data_type is TRAP_FMT_RAW, no data_fmt_spec is expected. Otherwise, data_fmt_spec contains e.g. UniRec template specifier (string representation)

Definition at line 231 of file trap_ifc.h.

◆ req_data_type

uint8_t trap_input_ifc_s::req_data_type

Required message format defined by trap_data_format_t

Definition at line 223 of file trap_ifc.h.

◆ terminate

ifc_terminate_func_t trap_input_ifc_s::terminate

Pointer to terminate function.

Definition at line 184 of file trap_ifc.h.


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