Cette rubrique décrit la syntaxe, les paramètres et les valeurs de retour des fonctions de traitement des requêtes. Elle fournit également des exemples d'utilisation pour chacune d'elles.
add_req_header
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | add_req_header(name, value [, append]) |
| Description | Ajoute un en-tête de requête avant le transfert vers le serveur d'origine. |
| Paramètre |
|
| Valeur de retour | Renvoie true par défaut et false si l'en-tête de requête spécifié n'est pas valide. |
| Exemple | |
del_req_header
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | del_req_header(name) |
| Description | Supprime un en-tête de requête avant le transfert vers le serveur d'origine. |
| Paramètre | name : nom de l'en-tête de requête à supprimer. Type de données : chaîne. |
| Valeur de retour | Renvoie true par défaut et false si l'en-tête de requête spécifié n'est pas valide. |
| Exemple | |
add_rsp_header
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | add_rsp_header(name, value [, append]) |
| Description | Ajoute un en-tête de réponse. |
| Paramètre |
|
| Valeur de retour | Renvoie true par défaut et false si l'en-tête de réponse spécifié n'est pas valide. |
| Exemple | |
del_rsp_header
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | del_rsp_header(name) |
| Description | Supprime un en-tête de réponse. |
| Paramètre | name : nom de l'en-tête de réponse à supprimer. Type de données : chaîne. |
| Valeur de retour | Renvoie true par défaut et false si l'en-tête de réponse spécifié n'est pas valide. |
| Exemple | |
encode_args
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | encode_args(d) |
| Description | Convertit les paires k/v du dictionnaire spécifié par d en une chaîne encodée URI au format k1=v1&k2=v2. |
| Paramètre | d : dictionnaire à convertir. |
| Valeur de retour | Renvoie une chaîne encodée URI. |
| Exemple | |
decode_args
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | decode_args(s) |
| Description | Convertit une chaîne encodée URI au format k1=v1&k2=v2 en une chaîne de type dictionnaire. |
| Paramètre | s : chaîne à convertir. |
| Valeur de retour | Renvoie un objet dictionnaire converti à partir de la chaîne spécifiée. |
| Exemple | |
rewrite
| Élément | Description |
| Syntaxe | rewrite(url, flag, code) |
| Description | Réécrit une URI ou effectue une redirection. |
| Paramètre |
|
| Valeur de retour |
|
| Exemple | |
say
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | say(arg) |
| Description | Affiche un corps de réponse et ajoute un caractère de saut de ligne à la fin de la sortie. |
| Paramètre | arg : contenu du corps de réponse. Type de données : tout type. |
| Valeur de retour | Aucune. |
| Exemple | |
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | print(arg) |
| Description | Affiche un corps de réponse. Contrairement à la fonction say(), cette fonction n'ajoute pas de saut de ligne à la fin de la sortie. |
| Paramètre | arg : contenu du corps de réponse. Type de données : tout type. |
| Valeur de retour | Aucune. |
| Exemple | |
exit
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | exit(code [, body]) |
| Description | Termine la requête en cours avec le code spécifié. Si le paramètre body est également défini, une réponse contenant le corps de réponse indiqué est renvoyée. |
| Paramètre |
|
| Valeur de retour | Aucune. |
| Exemple |
|
get_rsp_header
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | get_rsp_header(str) |
| Description | Récupère un en-tête de réponse. |
| Paramètre | str : en-tête de réponse à obtenir. Type de données : chaîne. |
| Valeur de retour | Renvoie l'en-tête de réponse spécifié sous forme de chaîne, nombre, dictionnaire ou booléen.
|
| Exemple | |
add_rsp_cookie
Le tableau suivant détaille cette fonction.
| Élément | Description |
| Syntaxe | add_rsp_cookie(k, v [,properties]) |
| Description | Définit le cookie de réponse. Chaque appel de cette fonction génère un nouvel en-tête de réponse Set-Cookie. |
| Paramètre |
|
| Valeur de retour | Renvoie true si le cookie spécifié est défini avec succès, et false en cas d'échec. |
| Exemple | Réponse : |