-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation-intro.html
More file actions
292 lines (274 loc) · 13.6 KB
/
documentation-intro.html
File metadata and controls
292 lines (274 loc) · 13.6 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Bref. Une API Zia - Documentation - Découvrir notre API</title>
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="./assets/css/bootstrap.css" rel="stylesheet">
<link href="./assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="./assets/css/prettify.css" rel="stylesheet">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-29009488-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body data-spy="scroll" data-target=".subnav" data-offset="50">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html">Bref.</a>
<div class="nav-collapse">
<ul class="nav">
<li><a href="index.html">Accueil</a></li>
<li class="active"><a href="documentation-intro.html">Découvrir l'API</a></li>
<li><a href="documentation-api.html">Implémenter l'API</a></li>
<li><a href="documentation-module.html">Implémenter un module</a></li>
<li><a href="doxygen">Doxygen</a></li>
<li><a href="https://github.com/bref/bref-api">Le projet sur Github</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<header class="jumbotron subhead" id="overview">
<h1>Découvrir l'API Bref</h1>
<p class="lead">Un rapide tour d'horizon de l'API Bref.</p>
</header>
<div class="flow"></div>
<div class="row">
<div class="span6">
<h1>Pipeline</h1>
<p>Notre API est basée sur un système de pipeline, à la fois simple et complet sur lequel
s'enregistre les modules du Zia grâce à un système de points d'encrage (hooks), représentés sur le
schéma ci-dessus par des points roses.
Vous trouverez le détail de chacun d'entre eux en passant votre pointeur dessus.</p>
<h2>Fonctionnement</h2>
<p>Les hooks sont enregistrés par le module en précisant <strong>la priorité d'exécution</strong> de celui-ci.
Chaque hook est appelé une seule fois par requête et peut retourner un <em>RequestHandler</em> qui
sera appelé une ou plusieurs fois (callback) en fonction du contexte.</p>
</div>
<div class="span6">
<iframe width="560" height="315" src="http://www.youtube.com/embed/sxFifF__h74" frameborder="0" allowfullscreen></iframe>
</div>
</div>
<h2>Exemple avec un module CGI</h2>
<p>Par exemple, on aurait un module CGI qui <em>piperait</em> le corps d'une requête POST sur un processus
CGI : <em>php-cgi</em>.</p>
<p>La classe du module héritant de <a href="/doxygen/classbref_1_1_i_module.html">IModule</a> enregistrerait un hook
<em>ContentHook</em>.</p>
<p>Cet hook serait ensuite appelé lors d'une nouvelle requête et vérifierait par exemple que l'extension soit
".php", exécuterait alors un processus <em>php-cgi</em>, définirait le fd correspondant standard du processus
et retournerait un <a href="/doxygen/classbref_1_1_pipeline_1_1_i_content_request_handler.html">IContentRequestHandler</a>.</p>
<p style="text-align: center;"><img src="./assets/img/hook.png" alt="Exemple d'un hook" /></p>
<p>La premère fonction fournie par le hook serait appelée
avec un morceau du corps de la requête jusqu'à ce que tout le corps ait été fourni.</p>
<p>La seconde serait appelée lors de la réception par le serveur de données sur le fd fournit, c'est à dire
lorsque le processus PHP écrira du contenu sur sa sortie standard.</p>
<p class="pull-right"><a class="btn" href="documentation-module.html">» Voir nos exemples de modules</a></p>
<h2>Liste des hooks disponibles</h2>
<h3>Gate</h3>
<p>La gate gère les communications avec l'extérieur et la génération des données.
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Nom du hook</th>
<th>Description</th>
<th>Exemple d'utilisation</th>
</tr>
</thead>
<tbody>
<tr>
<td>ConnectionHook</td>
<td id="ConnectionHook-text">Appelé lors de la connexion d'un client.</td>
<td id="ConnectionHook-ex">Blacklist</td>
</tr>
<tr>
<td>OnReceiveHook</td>
<td id="OnReceiveHook-text">Gestion de la lecture des sockets (derrière un système d'évènements tel que
select qui signale la présence de données disponibles sur la socket client).
On pourra lire directement sur la socket ou alors utiliser une couche SSL comme avec SSL_read().
</td>
<td id="OnReceiveHook-ex">SSL</td>
</tr>
<tr>
<td>OnSendHook</td>
<td id="OnSendHook-text">Appelé lorsqu'il y a des données à écrire sur les sockets.</td>
<td id="OnSendHook-ex">SSL</td>
</tr>
</tbody>
</table>
<h3>UpStream</h3>
<p>L'UpStream correspond aux actions effectuées avant la génération du contenu de la réponse.</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Nom du hook</th>
<th>Description</th>
<th>Exemple d'utilisation</th>
</tr>
</thead>
<tbody>
<tr>
<td>PostReadHook</td>
<td id="PostReadHook-text">Appelé après avoir reçu des données et avant l'exécution du
parsing du header.</td>
<td id="PostReadHook-ex">?</td>
</tr>
<tr>
<td>ParsingHook</td>
<td id="ParsingHook-text">Hook procédant au parsing de la requête HTTP.</td>
<td id="ParsingHook-ex">Parsing</td>
</tr>
<tr>
<td>PostParsingHook</td>
<td id="PostParsingHook-text">Appelé après le parsing du header HTTP.</td>
<td id="PostParsingHook-ex">Réécriture d'URL</td>
</tr>
</tbody>
</table>
<h3>Bridge</h3>
<p>Le bridge génère le contenu de la réponse, statique ou dynamique.</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Nom du hook</th>
<th>Description</th>
<th>Exemple d'utilisation</th>
</tr>
</thead>
<tbody>
<tr>
<td>ContentHook</td>
<td id="ContentHook-text">Appelé pour générer le contenu de la réponse. Le handler doit fournir
deux méthodes différentes : une d'entrée qui récupère le corps de la requête et une
qui génère le corps de la réponse.</td>
<td id="ContentHook-ex">CGI, Contenu statique, Listing des dossiers</td>
</tr>
</tbody>
</table>
<h3>DownStream</h3>
<p>Le DownStream génère la resultat final (encodage, compression, etc.).</p>
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Nom du hook</th>
<th>Description</th>
<th>Exemple d'utilisation</th>
</tr>
</thead>
<tbody>
<tr>
<td>PostContentHook</td>
<td id="PostContentHook-text">Appelé après la génération de contenu de la réponse,
avec un buffer contenant des "morceaux" du contenu généré.</td>
<td id="PostContentHook-ex">Cache côté serveur, Substitution</td>
</tr>
<tr>
<td>TransformHook</td>
<td id="TransformHook-text">Transformation du contenu de la réponse.</td>
<td id="TransformHook-ex">Encoding, compression</td>
</tr>
<tr>
<td>PreSendHook</td>
<td id="PreSendHook-text">Appelé juste avant l'écriture de la réponse sur la socket</td>
<td id="PreSendHook-ex">?</td>
</tr>
</tbody>
</table>
<h1>Environnement</h1>
<p>Chaque hook prendra une référence sur une structure en paramètre contenant "l'environnement"
de la requête, c'est à dire la configuration du serveur et un logger.</p>
<div class="row">
<div class="span4">
<h2>Configuration</h2>
<p>La configuration utilise un container, <a href="/doxygen/classbref_1_1_bref_value.html">BrefValue</a>,
qui embarque <a href="documentation-api.html#brefvalue">plusieurs types</a> et permet
d'importer facilement des configurations YAML, XML ou JSON.</p>
<p>Le serveur Zia devrait implémenter des <a href="documentation-api.html#confhelper">
méthodes d'aide</a> à la récupération d'éléments de configuration viables en fonction de
l'environnement : corps du serveur, VirtualHost, etc.</p>
<p class="pull-right">
<a href="documentation-api.html#brefvalue" class="btn">Implémentation de la configuration »</a>
</p>
</div>
<div class="span4">
<h2>Logger</h2>
<p>Afin de faciliter le log d'erreurs dans les modules, un logger est passé en paramètre aux hooks.
Il suffit d'utiliser les macros fournies utilisant notre ScopedLogger pour construire un message à
logger :</p>
<pre class="prettyprint">LOG_ERROR(env.logger) << "My Error : " << 42;</pre>
<p class="pull-right">
<a href="documentation-api.html#logger" class="btn">Implémentation du logger »</a>
</p>
</div>
<div class="span4">
<h2>Requêtes / Réponses HTTP</h2>
<p>Les requêtes et réponses HTTP utilisent aussi le conteneur
<a href="/doxygen/classbref_1_1_bref_value.html">BrefValue</a> pour stocker les différents headers, permettant
d'implémenter des potentielles méthodes d'aide communes entre votre configuration et vos requêtes,
par exemple pour parser des dates.
<p class="pull-right">
<a href="documentation-api.html#httprequest" class="btn">Implémentation du conteneur »</a>
</p>
</div>
</div>
<hr>
<footer>
<p class="pull-right">
<iframe src="http://ghbtns.com/github-btn.html?user=bref&repo=bref-api&type=watch&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="100px" height="30px"></iframe>
<iframe src="http://ghbtns.com/github-btn.html?user=bref&repo=bref-api&type=fork&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="90px" height="30px"></iframe>
<a href="http://twitter.com/BrefAPI"><img src="./assets/img/icon_twitter.png" alt="Suivez-nous sur twitter" /></a>
<a href="irc://irc.epitech.net/bref"><img src="./assets/img/icon_irc.png" alt="irc" /></a>
</p>
<p class="pull-left epilogo"><a href="http://www.epitech.eu"><img src="./assets/img/epitech.gif" alt="Epitech" /></a></p>
<p>Bref. L'API Zia Epitech Nantes 2014.</p>
<p>Par
<a href="http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=badaud_t">badaud_t</a>,
<a href="http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=chiron_f">chiron_f</a>,
<a href="http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=giersc_v">giersc_v</a>,
<a href="http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=papin_g">papin_g</a> et
<a href="http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=rannou_p">rannou_p</a>.
</p>
</footer>
</div>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script src="./assets/js/bootstrap-tooltip.js"></script>
<script src="./assets/js/bootstrap-popover.js"></script>
<script src="./assets/js/prettify/prettify.js"></script>
<script>
$(document).ready(function() {
prettyPrint();
$.get('http://bref.github.io/assets/img/pipeline.svg', function(data) {
$('.flow').html(data.documentElement);
var hooks = [ 'ConnectionHook', 'OnReceiveHook', 'OnSendHook',
'PostReadHook', 'ParsingHook', 'PostParsingHook',
'ContentHook',
'PostContentHook', 'TransformHook', 'PreSendHook' ];
$.each(hooks, function(index, value) {
$('#' + value).popover({ placement: 'top', title: value,
content: $('#' + value + '-text').text() + "<br /><br /><em>Exemple(s) : " + $('#' + value + '-ex').text() + "</em>"});
});
});
});
</script>
<script type="text/javascript">
var uvOptions = {};
(function() {
var uv = document.createElement('script'); uv.type = 'text/javascript'; uv.async = true;
uv.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'widget.uservoice.com/2Do8WywvBVXH9Qyv847nBA.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uv, s);
})();
</script>
</body>
</html>