Este tópico descreve a sintaxe, os parâmetros e os valores de retorno das funções de processamento de requisições, além de apresentar exemplos práticos de uso.
add_req_header
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | add_req_header(name, value [, append]) |
| Descrição | Adiciona um cabeçalho de requisição antes do redirecionamento para o servidor de origem. |
| Parâmetro |
|
| Valor de retorno | Retorna true por padrão e false se o cabeçalho de requisição especificado for inválido. |
| Exemplo | |
del_req_header
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | del_req_header(name) |
| Descrição | Remove um cabeçalho de requisição antes do redirecionamento para o servidor de origem. |
| Parâmetro | name: nome do cabeçalho de requisição a excluir. Tipo de dado: string. |
| Valor de retorno | Retorna true por padrão e false se o cabeçalho de requisição especificado for inválido. |
| Exemplo | |
add_rsp_header
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | add_rsp_header(name, value [, append]) |
| Descrição | Adiciona um cabeçalho de resposta. |
| Parâmetro |
|
| Valor de retorno | Retorna true por padrão e false se o cabeçalho de resposta especificado for inválido. |
| Exemplo | |
del_rsp_header
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | del_rsp_header(name) |
| Descrição | Exclua um cabeçalho de resposta. |
| Parâmetro | name: nome do cabeçalho de resposta a excluir. Tipo de dado: string. |
| Valor de retorno | Retorna true por padrão e false se o cabeçalho de resposta especificado for inválido. |
| Exemplo | |
encode_args
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | encode_args(d) |
| Descrição | Converte os pares k/v no dicionário especificado por d em uma string codificada por URI no formato k1=v1&k2=v2. |
| Parâmetro | d: o dicionário a converter. |
| Valor de retorno | Retorna uma string codificada por URI. |
| Exemplo | |
decode_args
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | decode_args(s) |
| Descrição | Converte uma string codificada por URI no formato k1=v1&k2=v2 em uma string do tipo dicionário. |
| Parâmetro | s: a string a converter. |
| Valor de retorno | Retorna um objeto de dicionário convertido a partir da string especificada. |
| Exemplo | |
rewrite
| Item | Descrição |
| Sintaxe | rewrite(url, flag, code) |
| Descrição | Executa uma reescrita de URI ou um redirecionamento. |
| Parâmetro |
|
| Valor de retorno |
|
| Exemplo | |
say
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | say(arg) |
| Descrição | Imprime um corpo de resposta e adiciona um caractere de nova linha ao final da saída. |
| Parâmetro | arg: o conteúdo do corpo da resposta. Tipo de dado: qualquer tipo. |
| Valor de retorno | Nenhum. |
| Exemplo | |
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | print(arg) |
| Descrição | Imprime um corpo de resposta. Diferente da função say(), esta função não adiciona uma nova linha ao final da saída. |
| Parâmetro | arg: o conteúdo do corpo da resposta. Tipo de dado: qualquer tipo. |
| Valor de retorno | Nenhum. |
| Exemplo | |
exit
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | exit(code [, body]) |
| Descrição | Encerra a requisição atual com o code especificado. Se o parâmetro body também for definido, uma resposta contendo o corpo especificado será retornada. |
| Parâmetro |
|
| Valor de retorno | Nenhum. |
| Exemplo |
|
get_rsp_header
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | get_rsp_header(str) |
| Descrição | Obtém um cabeçalho de resposta. |
| Parâmetro | str: o cabeçalho de resposta a obter. Tipo de dado: string. |
| Valor de retorno | Retorna o cabeçalho de resposta especificado nos tipos de dado string, number, dictionary ou Boolean.
|
| Exemplo | |
add_rsp_cookie
A tabela a seguir detalha esta função.
| Item | Descrição |
| Sintaxe | add_rsp_cookie(k, v [,properties]) |
| Descrição | Defina o cookie de resposta. Cada chamada à função gera um novo cabeçalho de resposta Set-Cookie. |
| Parâmetro |
|
| Valor de retorno | Retorna true se o cookie especificado for definido com sucesso e false se a definição do cookie falhar. |
| Exemplo | Resposta: |