amxp_signal.h File Reference

Ambiorix signal manager and signal API header file. More...

#include <amxc/amxc_variant.h>

Go to the source code of this file.

Data Structures
struct	_amxp_signal_mngr
	Structure containing the signal manager information. More...
struct	_amxp_signal
	Structure containing the signal information. More...

Typedefs
typedef struct _amxp_signal_mngr	amxp_signal_mngr_t
	Structure containing the signal manager information. More...
typedef struct _amxp_signal	amxp_signal_t
	Structure containing the signal information. More...
typedef void(*	amxp_deferred_fn_t) (const amxc_var_t *const data, void *const priv)
	Deferred callback function signature. More...

Functions
int	amxp_sigmngr_new (amxp_signal_mngr_t **sig_mngr)
	Constructor function, creates a new signal manager instance. More...
int	amxp_sigmngr_delete (amxp_signal_mngr_t **sig_mngr)
	Destructor function, deletes a signal manager instance. More...
int	amxp_sigmngr_init (amxp_signal_mngr_t *sig_mngr)
	Initializing function, initializes members of the amxp_signal_mngr_t structure. More...
int	amxp_sigmngr_clean (amxp_signal_mngr_t *sig_mngr)
	Clean-up functions, cleans-up all members of a amxp_signal_mngr_t structure. More...
int	amxp_sigmngr_add_signal (amxp_signal_mngr_t *const sig_mngr, const char *name)
	Adds a signal to a signal manager. More...
int	amxp_sigmngr_remove_signal (amxp_signal_mngr_t *const sig_mngr, const char *name)
	Removes a signal from a signal manager. More...
amxp_signal_t *	amxp_sigmngr_find_signal (const amxp_signal_mngr_t *const sig_mngr, const char *name)
	Get the pointer to the signal. More...
void	amxp_sigmngr_trigger_signal (amxp_signal_mngr_t *const sig_mngr, const char *name, const amxc_var_t *const data)
	Triggers a signal. More...
int	amxp_sigmngr_emit_signal (const amxp_signal_mngr_t *const sig_mngr, const char *name, const amxc_var_t *const data)
	Emits a signal. More...
int	amxp_sigmngr_deferred_call (amxp_signal_mngr_t *const sig_mngr, amxp_deferred_fn_t fn, const amxc_var_t *const data, void *priv)
	Defers a function call. More...
int	amxp_sigmngr_enable (amxp_signal_mngr_t *const sig_mngr, bool enable)
	Enables or disables the signal manager. More...
int	amxp_sigmngr_suspend (amxp_signal_mngr_t *const sig_mngr)
	Suspends the handling of signals for the signal manager. More...
int	amxp_sigmngr_resume (amxp_signal_mngr_t *const sig_mngr)
	Resumes the handling of signals for the signal manager. More...
int	amxp_signal_new (amxp_signal_mngr_t *sig_mngr, amxp_signal_t **signal, const char *name)
	Constructor function, creates a new signal. More...
int	amxp_signal_delete (amxp_signal_t **signal)
	Destructor function, deletes a signal. More...
void	amxp_signal_trigger (amxp_signal_t *const signal, const amxc_var_t *const data)
	Triggers a signal. More...
int	amxp_signal_emit (const amxp_signal_t *const signal, const amxc_var_t *const data)
	Emits a signal. More...
int	amxp_signal_read (void)
	Reads from the amxp signal file descriptor. More...
int	amxp_signal_fd (void)
	Gets the amxp signal file descriptor. More...
int	amxp_signal_disconnect_all (amxp_signal_t *const signal)
	Disconnects all slots from the signal. More...
const char *	amxp_signal_name (const amxp_signal_t *const signal)
	Gets the name of the signal. More...
bool	amxp_signal_has_slots (const amxp_signal_t *const signal)
	Checks if the signal has slots conencted. More...

Detailed Description

Ambiorix signal manager and signal API header file.

Definition in file amxp_signal.h.