dymload.h File Reference

#include <stick2xyz.h>

Include dependency graph for dymload.h:

Go to the source code of this file.

Macros
#define	STICK2XYZ_DYNAMIC_INSTDIR   "/usr/lib64/stick2xyz"
#define	LANGPACK_PTRS_SIZE   100
#define	OUTPUT2D_PTRS_SIZE   10
#define	PANE2D_PTRS_SIZE   10
#define	INPUT_PTRS_SIZE   10

Functions
int	funcptrs_init (void)
int	funcptrs_release (void)
int	funcptrs_init_modules (int multithread, int verbose)
void	funcptrs_release_modules (int sigterm)
int	funcptrs_output2d_getstruct (struct output2d_funcptrs *ptr, stick2xyz_pctchar libnam)
int	funcptrs_output2d_enumstruct (struct output2d_funcptrs *ptr, int libnum)
int	funcptrs_pane2d_getstruct (struct pane2d_funcptrs *ptr, stick2xyz_pctchar libnam)
int	funcptrs_pane2d_enumstruct (struct pane2d_funcptrs *ptr, int libnum)
int	funcptrs_input_getstruct (struct input_funcptrs *ptr, stick2xyz_pctchar libnam)
int	funcptrs_input_enumstruct (struct input_funcptrs *ptr, int libnum)

Macro Definition Documentation

INPUT_PTRS_SIZE

#define INPUT_PTRS_SIZE   10

Set this macro to the maximum amount of Input modules to be loaded.

Definition at line 45 of file dymload.h.

LANGPACK_PTRS_SIZE

#define LANGPACK_PTRS_SIZE   100

Set this macro to the maximum amount of langpack modules to be loaded.

Definition at line 30 of file dymload.h.

OUTPUT2D_PTRS_SIZE

#define OUTPUT2D_PTRS_SIZE   10

Set this macro to the maximum amount of Output 2-D modules to be loaded.

Definition at line 35 of file dymload.h.

PANE2D_PTRS_SIZE

#define PANE2D_PTRS_SIZE   10

Set this macro to the maximum amount of Pane 2-D modules to be loaded.

Definition at line 40 of file dymload.h.

STICK2XYZ_DYNAMIC_INSTDIR

#define STICK2XYZ_DYNAMIC_INSTDIR   "/usr/lib64/stick2xyz"

Set this macro to the directory that will/has the stick2xyz libraries.

Definition at line 25 of file dymload.h.

Function Documentation

funcptrs_init()

int funcptrs_init

(

void

)

This function initializes the function pointers in the dynamic library loader as needed. The function also increases the reference count.

Return values

>1	On success, no need to call funcptrs_init_modules.
1	On success, be sure to call funcptrs_init_modules.
0	On error.

funcptrs_init_modules()

int funcptrs_init_modules	(	int	multithread,
		int	verbose
	)

This function increments the reference count in all modules, but not the loader's reference count.

Parameters

[in]	multithread	1 If program is or expects to be running with multiple threads, 0 otherwise.
[in]	verbose	1 If verbose output is desired, 0 otherwise.

Return values

1	On success.
0	On failure.

funcptrs_input_enumstruct()

int funcptrs_input_enumstruct	(	struct input_funcptrs *	ptr,
		int	libnum
	)

This function gets function pointers to an Input module by location in an internal array.

Note

This function is safe to use in a for loop.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnum	The array location number to retrieve function pointer data from.

funcptrs_input_getstruct()

int funcptrs_input_getstruct	(	struct input_funcptrs *	ptr,
		stick2xyz_pctchar	libnam
	)

This function gets function pointers to an Input module by name.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnam	The name of the module to retrieve function pointer data from.

funcptrs_output2d_enumstruct()

int funcptrs_output2d_enumstruct	(	struct output2d_funcptrs *	ptr,
		int	libnum
	)

This function gets function pointers to an Output 2-D module by location in an internal array.

Note

This function is safe to use in a for loop.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnum	The array location number to retrieve function pointer data from.

funcptrs_output2d_getstruct()

int funcptrs_output2d_getstruct	(	struct output2d_funcptrs *	ptr,
		stick2xyz_pctchar	libnam
	)

This function gets function pointers to an Output 2-D module by name.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnam	The name of the module to retrieve function pointer data from.

funcptrs_pane2d_enumstruct()

int funcptrs_pane2d_enumstruct	(	struct pane2d_funcptrs *	ptr,
		int	libnum
	)

This function gets function pointers to a Pane 2-D module by location in an internal array.

Note

This function is safe to use in a for loop.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnum	The array location number to retrieve function pointer data from.

funcptrs_pane2d_getstruct()

int funcptrs_pane2d_getstruct	(	struct pane2d_funcptrs *	ptr,
		stick2xyz_pctchar	libnam
	)

This function gets function pointers to a Pane 2-D module by name.

Parameters

[out]	ptr	A pointer in memory to store the result.
[in]	libnam	The name of the module to retrieve function pointer data from.

funcptrs_release()

int funcptrs_release

(

void

)

This function decrements the reference count. When reference count becomes zero, the resources in the dynamic library loader are freed.

funcptrs_release_modules()

void funcptrs_release_modules

(

int

sigterm

)

This function allows for emergency unloading of the modules. This function should only be called after a signal handler returns due to SIGTERM.

Parameters

[in]

sigterm

Set to SIGTERM for emergency release. Set to SIGKILL if only decrementing reference counts in the modules.