Libtrap: Internal development docs  1.16.1
Data Fields
trap_output_ifc_s Struct Reference

#include <trap_ifc.h>

Data Fields

ifc_get_id_func_t get_id
 Pointer to get_id function. More...
 
ifc_disconn_clients_func_t disconn_clients
 Pointer to disconnect_clients function. More...
 
ifc_send_func_t send
 Pointer to send function. More...
 
ifc_flush_func_t flush
 Pointer to flush 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...
 
ifc_get_client_count_func_t get_client_count
 Pointer to get_client_count function. More...
 
ifc_get_client_stats_json_func_t get_client_stats_json
 Pointer to get_client_stats_json function. More...
 
void * priv
 Pointer to instance's private data. More...
 
pthread_mutex_t ifc_mtx
 Locking mutex for interface. More...
 
int64_t timeout
 Internal structure to send partial data after timeout (autoflush). More...
 
int32_t datatimeout
 Timeout for *_send() calls. More...
 
char ifc_type
 Type of interface. More...
 
char bufferswitch
 Enable (1) or Disable (0) buffering, default is Enabled (1). More...
 
char timeout_fixed
 
char bufferswitch_fixed
 
char datatimeout_fixed
 
char * data_fmt_spec
 
uint8_t data_type
 

Detailed Description

Struct to hold an instance of some output interface.

Definition at line 235 of file trap_ifc.h.

Field Documentation

◆ bufferswitch

char trap_output_ifc_s::bufferswitch

Enable (1) or Disable (0) buffering, default is Enabled (1).

Definition at line 250 of file trap_ifc.h.

◆ bufferswitch_fixed

char trap_output_ifc_s::bufferswitch_fixed

If 1 do not allow to change bufferswitch by module. If 0 - bufferswitch can be changed by standard way using trap_ctx_ifcctl().

Definition at line 262 of file trap_ifc.h.

◆ create_dump

ifc_create_dump_func_t trap_output_ifc_s::create_dump

Pointer to function for generating of dump.

Definition at line 242 of file trap_ifc.h.

◆ data_fmt_spec

char* trap_output_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 277 of file trap_ifc.h.

◆ data_type

uint8_t trap_output_ifc_s::data_type

Message format defined by trap_data_format_t

Definition at line 282 of file trap_ifc.h.

◆ datatimeout

int32_t trap_output_ifc_s::datatimeout

Timeout for *_send() calls.

Definition at line 248 of file trap_ifc.h.

◆ datatimeout_fixed

char trap_output_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 269 of file trap_ifc.h.

◆ destroy

ifc_destroy_func_t trap_output_ifc_s::destroy

Pointer to destructor function.

Definition at line 241 of file trap_ifc.h.

◆ disconn_clients

ifc_disconn_clients_func_t trap_output_ifc_s::disconn_clients

Pointer to disconnect_clients function.

Definition at line 237 of file trap_ifc.h.

◆ flush

ifc_flush_func_t trap_output_ifc_s::flush

Pointer to flush function.

Definition at line 239 of file trap_ifc.h.

◆ get_client_count

ifc_get_client_count_func_t trap_output_ifc_s::get_client_count

Pointer to get_client_count function.

Definition at line 243 of file trap_ifc.h.

◆ get_client_stats_json

ifc_get_client_stats_json_func_t trap_output_ifc_s::get_client_stats_json

Pointer to get_client_stats_json function.

Definition at line 244 of file trap_ifc.h.

◆ get_id

ifc_get_id_func_t trap_output_ifc_s::get_id

Pointer to get_id function.

Definition at line 236 of file trap_ifc.h.

◆ ifc_mtx

pthread_mutex_t trap_output_ifc_s::ifc_mtx

Locking mutex for interface.

Definition at line 246 of file trap_ifc.h.

◆ ifc_type

char trap_output_ifc_s::ifc_type

Type of interface.

Definition at line 249 of file trap_ifc.h.

◆ priv

void* trap_output_ifc_s::priv

Pointer to instance's private data.

Definition at line 245 of file trap_ifc.h.

◆ send

ifc_send_func_t trap_output_ifc_s::send

Pointer to send function.

Definition at line 238 of file trap_ifc.h.

◆ terminate

ifc_terminate_func_t trap_output_ifc_s::terminate

Pointer to terminate function.

Definition at line 240 of file trap_ifc.h.

◆ timeout

int64_t trap_output_ifc_s::timeout

Internal structure to send partial data after timeout (autoflush).

Definition at line 247 of file trap_ifc.h.

◆ timeout_fixed

char trap_output_ifc_s::timeout_fixed

If 1 do not allow to change autoflush timeout by module. If 0 - autoflush can be changed by standard way using trap_ctx_ifcctl().

Definition at line 256 of file trap_ifc.h.


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