Collaboration diagram for Simple API:

Modules
	Message format

Functions
int	trap_free_ifc_spec (trap_ifc_spec_t ifc_spec)

int	trap_init (trap_module_info_t *module_info, trap_ifc_spec_t ifc_spec)

int	trap_terminate ()

int	trap_finalize ()

int	trap_send_data (unsigned int ifcidx, const void *data, uint16_t size, int timeout)

int	trap_recv (uint32_t ifcidx, const void *data, uint16_t size)
	Receive data from input interface. More...

int	trap_send (uint32_t ifcidx, const void *data, uint16_t size)
	Send data via output interface. More...

void	trap_set_verbose_level (int level)

int	trap_get_verbose_level ()

void	trap_set_help_section (int level)

void	trap_print_help (const trap_module_info_t *module_info)

void	trap_print_ifc_spec_help ()

int	trap_ifcctl (int8_t type, uint32_t ifcidx, int32_t request,...)
	Control TRAP interface. More...

void	trap_send_flush (uint32_t ifc)
	Force flush of buffer. More...

Variables
int	trap_last_error
	Code of last error (one of the codes above) More...

const char *	trap_last_error_msg
	Human-readable message about last error. More...

Detailed Description

Function Documentation

◆ trap_finalize()

int trap_finalize ( )

Cleanup function. Disconnect all interfaces and do all necessary cleanup.

Returns: Error code

Definition at line 578 of file trap.c.

◆ trap_free_ifc_spec()

int trap_free_ifc_spec ( trap_ifc_spec_t ifc_spec )

Destructor of trap_ifc_spec_t structure.

Parameters

[in] ifc_spec trap_ifc_spec_t structure to clear.

Returns: Error code (0 on success)

Definition at line 497 of file trap.c.

◆ trap_get_verbose_level()

int trap_get_verbose_level ( )

Get verbosity level. See trap_set_verbose_level for list of levels.

Returns: Verbosity level currently set in the library.

Definition at line 663 of file trap.c.

◆ trap_ifcctl()

int trap_ifcctl	(	int8_t	type,
		uint32_t	ifcidx,
		int32_t	request,
			...
	)

Control TRAP interface.

Note: Type and request types were changed from enum because of python wrapper.

Parameters

[in]	type	trap_ifc_type direction of interface
[in]	ifcidx	index of TRAP interface
[in]	request	trap_ifcctl_request type of operation
[in,out]	...	arguments of request, see trap_ifcctl_request for more details on requests and their arguments.

Examples:

// set 4 seconds timeout
trap_ifcctl(TRAPIFC_INPUT, 0, TRAPCTL_SETTIMEOUT, 4000000);
// disable auto-flush
trap_ifcctl(TRAPIFC_OUTPUT, 0, TRAPCTL_AUTOFLUSH_TIMEOUT, TRAP_NO_AUTO_FLUSH);
// disable buffering
trap_ifcctl(TRAPIFC_OUTPUT, 0, TRAPCTL_BUFFERSWITCH, 0);

Returns: TRAP_E_OK on success

Definition at line 1231 of file trap.c.

◆ trap_init()

int trap_init	(	trap_module_info_t *	module_info,
		trap_ifc_spec_t	ifc_spec
	)

Initialization function. Create and initialize all interfaces.

Parameters

[in]	module_info	Pointer to struct containing info about the module.
[in]	ifc_spec	Structure with specification of interface types and their parameters.

Returns: Error code (0 on success)

Definition at line 526 of file trap.c.

◆ trap_print_help()

void trap_print_help ( const trap_module_info_t * module_info )

Print common TRAP help message. The help message contains information from module_info and describes common TRAP command-line parameters.

Parameters

[in] module_info Pointer to struct containing info about the module.

Definition at line 898 of file trap.c.

◆ trap_print_ifc_spec_help()

void trap_print_ifc_spec_help ( )

Print help about interface specifier. Prints help message about format of interface specifier and description of all available interface types. This message is normally a part of help printed by trap_print_help, this function is useful when you don't use standard TRAP command-line parameters but you still use the same format of interface specifier.

Print help about interface specifier. Prints help message about format of interface specifier and description of all available interface types.

Definition at line 1138 of file trap.c.

◆ trap_recv()

int trap_recv	(	uint32_t	ifcidx,
		const void **	data,
		uint16_t *	size
	)

Receive data from input interface.

Receive a message from interface specified by ifcidx and set pointer to the data. When function returns due to timeout, contents of data and size are undefined.

Parameters

[in]	ifcidx	Index of input IFC.
[out]	data	Pointer to received data.
[out]	size	Size of received data in bytes of data.

Returns: Error code - TRAP_E_OK on success, TRAP_E_TIMEOUT if timeout elapses.

Note: Data must not be freed! Library stores incomming data into static array and rewrites it during every trap_recv() call.

See also: trap_ifcctl() to set timeout (TRAPCTL_SETTIMEOUT)

Definition at line 631 of file trap.c.

◆ trap_send()

int trap_send	(	uint32_t	ifcidx,
		const void *	data,
		uint16_t	size
	)

Send data via output interface.

Send a message given by data pointer of size message size via interface specified by ifcidx that is the index of output interfaces (counted from 0).

Parameters

[in]	ifcidx	Index of input IFC.
[out]	data	Pointer to message to send.
[out]	size	Size of message in bytes.

Returns: Error code - TRAP_E_OK on success, TRAP_E_TIMEOUT if timeout elapses.

See also: trap_ifcctl() to set timeout (TRAPCTL_SETTIMEOUT)

Definition at line 624 of file trap.c.

◆ trap_send_data()

int trap_send_data	(	unsigned int	ifcidx,
		const void *	data,
		uint16_t	size,
		int	timeout
	)

Send data to output interface. Write data of size size given by data pointer into interface ifc. If data cannot be written immediately (e.g. because of full buffer or lost connection), wait until write is possible or timeout microseconds elapses. If timeout < 0, wait indefinitely.

Parameters

[in]	ifcidx	Index of interface to write into.
[in]	data	Pointer to data.
[in]	size	Number of bytes of data.
[in]	timeout	Timeout in microseconds for non-blocking mode; timeout can be also: TRAP_WAIT, TRAP_HALFWAIT, or TRAP_NO_WAIT.

Returns: Error code - 0 on success, TRAP_E_TIMEOUT if timeout elapses.

Deprecated:: This function should be replaced by trap_send().

Definition at line 618 of file trap.c.

◆ trap_send_flush()

void trap_send_flush ( uint32_t ifc )

Force flush of buffer.

Parameters

[in] ifc IFC Index of interface to write into.

Definition at line 1241 of file trap.c.

◆ trap_set_help_section()

void trap_set_help_section ( int level )

Set section for trap_print_help()

Parameters

[in] level 0 for default info about module, 1 for info about IFC specifier

Definition at line 324 of file trap.c.

◆ trap_set_verbose_level()

void trap_set_verbose_level ( int level )

Set verbosity level of library functions. Verbosity levels may be:

-3 - errors
-2 - warnings
-1 - notices (default)
0 - verbose
1 - more verbose
2 - even more verbose

Parameters

[in] level Desired level of verbosity.

Set verbosity level. Verbosity levels are:

-3 - errors
-2 - warnings
-1 - notices (default)
0 - verbose
1 - more verbose
2 - even more verbose

Parameters

[in] level Desired level of verbosity.

Definition at line 654 of file trap.c.

◆ trap_terminate()

int trap_terminate ( )

Function to terminate module's operation. This function stops all read/write operations on all interfaces. Any waiting in trap_recv() and trap_send()_data is interrupted and these functions return immediately with TRAP_E_TERMINATED. Any call of trap_recv() or trap_send() after call of this function returns TRAP_E_TERMINATED.

This function is used to terminate module's operation (asynchronously), e.g. in SIGTERM handler.

Returns: Always TRAP_E_OK (0).

Definition at line 563 of file trap.c.

Variable Documentation

◆ trap_last_error

int trap_last_error

Code of last error (one of the codes above)

Definition at line 123 of file trap.c.

◆ trap_last_error_msg

const char* trap_last_error_msg

Human-readable message about last error.

Definition at line 125 of file trap.c.

Modules

Functions

Variables

Detailed Description

Function Documentation

◆ trap_finalize()

◆ trap_free_ifc_spec()

◆ trap_get_verbose_level()

◆ trap_ifcctl()

◆ trap_init()

◆ trap_print_help()

◆ trap_print_ifc_spec_help()

◆ trap_recv()

◆ trap_send()

◆ trap_send_data()

◆ trap_send_flush()

◆ trap_set_help_section()

◆ trap_set_verbose_level()

◆ trap_terminate()

Variable Documentation

◆ trap_last_error

◆ trap_last_error_msg