Signal managers

Collaboration diagram for Signal managers:

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

Typedefs
typedef struct _amxp_signal_mngr	amxp_signal_mngr_t
	Structure containing the signal manager information. 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...

Detailed Description

A signal manager is a collection of named signals. It can trigger or emit a signal.

Typedef Documentation

amxp_signal_mngr_t

typedef struct _amxp_signal_mngr amxp_signal_mngr_t

Structure containing the signal manager information.

Function Documentation

amxp_sigmngr_add_signal()

int amxp_sigmngr_add_signal	(	amxp_signal_mngr_t *const	sig_mngr,
		const char *	name
	)

Adds a signal to a signal manager.

Creates a new signal with the given name and adds it to the signal manager. If sig_mngr is NULL the newly created signal is added to the global signal manager. A isgnal name must be unique. If a signal with the name already exists in the signal manager, this function fails.

Parameters

sig_mngr	ponter to the sig_mngr pointer. Will be set to NULL
name	the name of the signal

Returns

0 when successful, otherwise an error code

Definition at line 433 of file amxp_signal.c.

                                              {
    int retval = -1;
    amxp_signal_t* signal = NULL;
    amxp_signal_mngr_t* mngr = (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
 
    when_null(name, exit);
    when_true(*name == 0, exit)
 
    retval = amxp_signal_new(mngr, &signal, name);
 
exit:
    return retval;
}

amxp_sigmngr_clean()

int amxp_sigmngr_clean

(

amxp_signal_mngr_t *

sig_mngr

)

Clean-up functions, cleans-up all members of a amxp_signal_mngr_t structure.

All signals of the signal manager will be removed, all connected slots will be automatically disconnected

Parameters

sig_mngr

pointer to a amxp_signal_mngr_t structure

Returns

0 when successful, otherwise an error code

Definition at line 405 of file amxp_signal.c.

                                                     {
    int retval = -1;
    amxc_llist_it_t* it = NULL;
    char buffer[1];
 
    when_null(sig_mngr, exit);
 
    amxp_signal_queue_lock();
 
    amxc_llist_it_take(&sig_mngr->it);
    it = amxc_lqueue_remove(&sig_mngr->signal_queue);
    while(it) {
        amxp_free_queued_signals(it);
        when_true_status(read(amxp_sigctrl.sigpipe[0], buffer, 1) == -1, exit, amxp_signal_queue_unlock());
        it = amxc_lqueue_remove(&sig_mngr->signal_queue);
    }
    amxc_llist_clean(&sig_mngr->regexp_slots, amxp_free_slots);
    amxc_htable_clean(&sig_mngr->signals, amxp_free_signals);
 
    amxp_signal_queue_unlock();
 
    retval = 0;
 
exit:
 
    return retval;
}

amxp_sigmngr_delete()

int amxp_sigmngr_delete

(

amxp_signal_mngr_t **

sig_mngr

)

Destructor function, deletes a signal manager instance.

All signals of the signal manager will be removed, all connected slots will be automatically disconnected

Parameters

sig_mngr

ponter to the sig_mngr pointer. Will be set to NULL

Returns

0 when successful, otherwise an error code

Definition at line 349 of file amxp_signal.c.

                                                       {
    int retval = -1;
 
    when_null(sig_mngr, exit);
    when_null(*sig_mngr, exit);
 
    if((*sig_mngr)->triggered) {
        (*sig_mngr)->deleted = true;
        amxc_htable_for_each(hit, &(*sig_mngr)->signals) {
            amxp_signal_t* sig = amxc_container_of(hit, amxp_signal_t, hit);
            if(sig != amxp_sigctrl.sigall) {
                sig->mngr = NULL;
            }
        }
    } else {
        amxp_sigmngr_clean((*sig_mngr));
        if(*sig_mngr != &amxp_sigmngr) {
            free(*sig_mngr);
        }
    }
 
    *sig_mngr = NULL;
    retval = 0;
 
exit:
    return retval;
}

amxp_sigmngr_find_signal()

amxp_signal_t* amxp_sigmngr_find_signal	(	const amxp_signal_mngr_t *const	sig_mngr,
		const char *	name
	)

Get the pointer to the signal.

Searches the signal manager for the given signal, if no signal is found with the given name, the functions returns a NULL pointer.

When sig_mngr is NULL, the signal is searched in the global signal manager.

The returned pointer can be used in all amxp signal functions that take a pointer to amxp_signal_t struct

Parameters

sig_mngr	ponter to the sig_mngr pointer. Will be set to NULL
name	the name of the signal

Returns

A amxp_signal_t pointer or NULL when no signal is found

Definition at line 475 of file amxp_signal.c.

                                                          {
    amxp_signal_t* signal = NULL;
    amxc_htable_it_t* hit = NULL;
    const amxp_signal_mngr_t* mngr = (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
 
    when_null(name, exit);
    when_true(*name == 0, exit)
 
    hit = amxc_htable_get(&mngr->signals, name);
    when_null(hit, exit);
    signal = amxc_htable_it_get_data(hit, amxp_signal_t, hit);
 
exit:
    return signal;
}

amxp_sigmngr_init()

int amxp_sigmngr_init

(

amxp_signal_mngr_t *

sig_mngr

)

Initializing function, initializes members of the amxp_signal_mngr_t structure.

Use this function when the amxp_signal_mngr_t structure is declared on the stack. It will initialize all members of this structure.

Parameters

sig_mngr

pointer to a amxp_signal_mngr_t structure

Returns

0 when successful, otherwise an error code

Definition at line 377 of file amxp_signal.c.

                                                    {
    int retval = -1;
    when_null(sig_mngr, exit);
 
    amxp_signal_queue_lock();
 
    amxc_llist_it_init(&sig_mngr->it);
    amxc_lqueue_init(&sig_mngr->signal_queue);
    when_false_status(amxc_htable_init(&sig_mngr->signals, 20) == 0, exit, amxp_signal_queue_unlock());
    amxc_llist_init(&sig_mngr->regexp_slots);
    amxc_llist_append(&amxp_sigctrl.sigmngrs, &sig_mngr->it);
    sig_mngr->enabled = true;
    sig_mngr->deleted = false;
    sig_mngr->triggered = false;
    sig_mngr->suspended = false;
 
    amxp_signal_queue_unlock();
 
    retval = 0;
 
exit:
    if((retval != 0) &&
       (sig_mngr != NULL)) {
        amxc_htable_clean(&sig_mngr->signals, NULL);
    }
    return retval;
}

amxp_sigmngr_new()

int amxp_sigmngr_new

(

amxp_signal_mngr_t **

sig_mngr

)

Constructor function, creates a new signal manager instance.

This function allocates memory, to free the allocated memory use the destruction function amxp_sigmngr_delete

Parameters

sig_mngr

where to store the sig_mngr pointer

Returns

0 when successful, otherwise an error code

Definition at line 330 of file amxp_signal.c.

                                                    {
    int retval = -1;
    when_null(sig_mngr, exit);
 
    *sig_mngr = (amxp_signal_mngr_t*) calloc(1, sizeof(amxp_signal_mngr_t));
    when_null(sig_mngr, exit);
 
    retval = amxp_sigmngr_init((*sig_mngr));
 
exit:
    if((retval != 0) &&
       (sig_mngr != NULL) &&
       (*sig_mngr != NULL)) {
        free(*sig_mngr);
        *sig_mngr = NULL;
    }
    return retval;
}

amxp_sigmngr_remove_signal()

int amxp_sigmngr_remove_signal	(	amxp_signal_mngr_t *const	sig_mngr,
		const char *	name
	)

Removes a signal from a signal manager.

When sig_mngr is NULL, the signal will be removed from the global signal manager.

If no signal is found in the the signal manager with the given name, this function fails.

Note

This function removes the signal from the signal manager, but does not free the memory allocated for the signal. When this function is called from within a slot callback function, the memory will be freed automatically when the slot callback function returns.

Parameters

sig_mngr	ponter to the sig_mngr pointer. Will be set to NULL
name	the name of the signal

Returns

0 when successful, otherwise an error code

Definition at line 448 of file amxp_signal.c.

                                                 {
    int retval = -1;
    amxp_signal_t* signal = NULL;
    amxp_signal_mngr_t* mngr = (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
    amxc_htable_it_t* hit = NULL;
 
    amxp_signal_queue_lock();
 
    when_null(name, exit);
    when_true(*name == 0, exit)
 
    hit = amxc_htable_get(&mngr->signals, name);
    when_null(hit, exit);
 
    signal = amxc_htable_it_get_data(hit, amxp_signal_t, hit);
    amxc_htable_it_clean(hit, NULL);
    amxp_signal_disconnect_all(signal);
    signal->mngr = NULL;
 
    retval = 0;
 
exit:
    amxp_signal_queue_unlock();
    return retval;
}

amxp_sigmngr_trigger_signal()

void amxp_sigmngr_trigger_signal	(	amxp_signal_mngr_t *const	sig_mngr,
		const char *	name,
		const amxc_var_t *const	data
	)

Triggers a signal.

Searches the signal manager for the given signal and triggers the signal. This function is basically the same as calling amxp_sigmngr_find_signal and amxp_signal_trigger in sequence.

When sig_mngr is NULL, the signal is searched in the global signal manager.

When no signal is found with the given name, nothing is done.

Parameters

sig_mngr	ponter to the sig_mngr pointer. Will be set to NULL
name	the name of the signal
data	the data that is passed to all the slots.

Definition at line 492 of file amxp_signal.c.

                                                               {
    amxp_signal_t* signal = NULL;
    amxp_signal_mngr_t* mngr = (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
 
    when_null(name, exit);
    when_true(*name == 0, exit);
    when_true(mngr->suspended, exit);
 
    signal = amxp_sigmngr_find_signal(mngr, name);
    if(signal != NULL) {
        amxp_signal_trigger(signal, data);
    } else {
        amxp_sigmngr_trigger_regexp(mngr, name, data);
        amxp_sigmngr_garbage_collect(mngr);
    }
 
exit:
    return;
}