Chaser Pool

Collaboration diagram for Chaser Pool:

Modules
	DMX512_Chaser

Data Structures
struct	DMX512_chaser_pool_s
	Defines a DMX512 chaser pool object. More...

Functions
DMX512_chaser_pool_s *	DMX512_chaser_pool_new (void)
	Creates a new chaser pool instance. More...
DMX512_engine_err_e	DMX512_chaser_pool_add (DMX512_chaser_pool_s *chaser_pool, DMX512_chaser_s chaser)
	Adds a chaser instance into the pool. More...
DMX512_engine_err_e	DMX512_chaser_pool_del (DMX512_chaser_pool_s *chaser_pool, uint16_t id)
	Deletes a chaser instance from the pool. More...
DMX512_engine_err_e	DMX512_chaser_pool_get (DMX512_chaser_pool_s *chaser_pool, uint16_t id, DMX512_chaser_s **chaser)
	Gets a chaser instance from the pool. More...
void	DMX512_chaser_pool_manage (DMX512_chaser_pool_s *chaser_pool)
	Manages execution of chaser instances for a whole pool. More...
void	DMX512_chaser_pool_free (DMX512_chaser_pool_s *chaser_pool)
	Frees instance pool. More...

Detailed Description

Chaser pools are used to store and manage a lists of pre-configured chasers. Up to 65535 DMX512 chasers may be stored for each individual DMX512 universe.

Function Documentation

DMX512_chaser_pool_add()

DMX512_engine_err_e DMX512_chaser_pool_add	(	DMX512_chaser_pool_s *	chaser_pool,
		DMX512_chaser_s	chaser
	)

Adds a chaser instance into the pool.

Parameters

*chaser_pool	pointer to the chaser pool instance
chaser	chaser instance to be added to the pool

Returns

DMX512_engine_err_e error code following the function call

Definition at line 60 of file DMX512_chaser_pool.c.

DMX512_chaser_pool_del()

DMX512_engine_err_e DMX512_chaser_pool_del	(	DMX512_chaser_pool_s *	chaser_pool,
		uint16_t	id
	)

Deletes a chaser instance from the pool.

Parameters

*chaser_pool	pointer to the chaser pool instance
id	the chaser idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 82 of file DMX512_chaser_pool.c.

DMX512_chaser_pool_free()

void DMX512_chaser_pool_free

(

DMX512_chaser_pool_s *

chaser_pool

)

Frees instance pool.

Parameters

chaser_pool

pointer to a chaser pool instance

Definition at line 138 of file DMX512_chaser_pool.c.

DMX512_chaser_pool_get()

DMX512_engine_err_e DMX512_chaser_pool_get	(	DMX512_chaser_pool_s *	chaser_pool,
		uint16_t	id,
		DMX512_chaser_s **	chaser
	)

Gets a chaser instance from the pool.

Parameters

*chaser_pool	pointer to the chaser pool instance
id	the chaser identifier

Returns

*DMX512_chaser_s pointer to the chaser instance

Definition at line 107 of file DMX512_chaser_pool.c.

DMX512_chaser_pool_manage()

void DMX512_chaser_pool_manage

(

DMX512_chaser_pool_s *

chaser_pool

)

Manages execution of chaser instances for a whole pool.

Parameters

chaser_pool

pointer to a chaser pool instance

Definition at line 127 of file DMX512_chaser_pool.c.

DMX512_chaser_pool_new()

DMX512_chaser_pool_s * DMX512_chaser_pool_new

(

void

)

Creates a new chaser pool instance.

Returns

DMX512_chaser_pool_s the created pool instance

Definition at line 46 of file DMX512_chaser_pool.c.