1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* EIOTAS
* Copyright (C) 2012 Jérémy Zurcher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library;
* if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __EIOTAS_SPIN_H__
#define __EIOTAS_SPIN_H__
#include "eiotas_room.h"
#include "eiotas_iota.h"
#include "eiotas_particle.h"
#include <eina_inlist.h>
#include <eina_array.h>
/**
* @typedef Eiotas_Spin
* Type for a Spin, the top level Room which holds @ref Eiotas_Particle fifos and free @ref Eiotas_Particle.
*/
typedef struct _Eiotas_Spin Eiotas_Spin;
/**
* @struct _Eiotas_Spin
* Struct for a Spin, the top level Room which holds @ref Eiotas_Particle fifos and free @ref Eiotas_Particle.
*/
struct _Eiotas_Spin {
Eiotas_Room room; /**< higher level Room */
Eina_Array *free_particles; /**< lifo of free to reuse @ref Eiotas_Particle TODO support different particle types, use an Eina_Hash */
Eina_Inlist *app_fifo; /**< fifo of application priority particles */
Eina_Inlist *sys_fifo; /**< fifo of system priority particles */
};
/**
* @defgroup Eiotas_Spin Eiotas_Spin
*
* A Eiota_Spin is the top level object. It holds @ref Eiotas_Particle free list,
* @ref Eiotas_Particle system and application fifos.
*
* @{
*/
/**
* @brief Free allocated resources.
*
* @param spin The @ref Eiotas_Spin to free.
*
* This function will free all it's child Iotas,
* all the @ref Eiotas_Particle holded in app_fifo, sys_fifo and free_particles.
*/
EAPI void eiotas_spin_free(Eiotas_Spin *spin);
/**
* @brief Allocate the resources.
*
* @param name The name of this spin.
* @param step The count of pointers to add when increasing the fifo size.
*
* @return the new allocated @ref Eiotas_Spin @c NULL on failure
*
* @see eina_array_new().
*/
EAPI Eiotas_Spin* eiotas_spin_add(const char* name, unsigned int step);
/**
* @brief Require a @ref Eiotas_Particle from the free list.
*
* @param spin The @ref Eiotas_Spin to require a @ref Eiotas_Particle from.
*
* @return a ready to use @ref Eiotas_Particle
*
* This function will allocate and initialize a new @ref Eiotas_Particle if there is none in the free list.
*/
EAPI Eiotas_Particle* eiotas_spin_require_particle(Eiotas_Spin *spin);
/**
* @brief Release a particle.
*
* @param spin The @ref Eiotas_Spin to restore the particle to.
* @param particle The @ref Eiotas_Particle to be restored.
*
* This function calls eiotas_particle_reset() before giving back the @ref Eiotas_Particle.
* Each @ref Eiotas_Particle merged in the first one are also released.
*
* @see eiotas_particle_reset().
*/
EAPI void eiotas_spin_release_particle(Eiotas_Spin *spin, Eiotas_Particle *particle);
/**
* @brief Append the @ref Eiotas_Particle to the app or sys fifo.
*
* @param spin The @ref Eiotas_Spin to post the particle to.
* @param particle The @ref Eiotas_Particle to be sent.
* @param system Post to the system fifo us true, otherwise to the application fifo.
*
*/
EAPI void eiotas_spin_send_particle(Eiotas_Spin *spin, const Eiotas_Particle *particle, Eina_Bool system);
/**
* @brief Require a @ref Eiotas_Particle from the free list.
*
* @see eiotas_spin_require_particle
*/
#define eiotas_require_particle(_iota) eiotas_spin_require_particle((Eiotas_Spin*)((Eiotas_Iota*)(_iota))->spin)
/**
* @brief Release a particle.
*
* @see eiotas_spin_release_particle
*/
#define eiotas_release_particle(_iota,_particle) eiotas_spin_release_particle((Eiotas_Spin*)((Eiotas_Iota*)(_iota))->spin,_particle)
/**
* @}
*/
#endif // __EIOTAS_SPIN_H__
|
