User Tools
cookbooks:5.3.x:pseudovariables
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
cookbooks:5.3.x:pseudovariables [2019/10/10 14:53] miconda created |
cookbooks:5.3.x:pseudovariables [2019/11/15 15:07] giavac [$http_req(key)] |
||
|---|---|---|---|
| Line 20: | Line 20: | ||
| * avpops | * avpops | ||
| * htable | * htable | ||
| + | * http_async_client | ||
| * textops | * textops | ||
| * uac | * uac | ||
| Line 1344: | Line 1345: | ||
| ... | ... | ||
| </ | </ | ||
| + | |||
| + | ===== http_async_client module Pseudo-Variables ===== | ||
| + | |||
| + | ==== $http_req_id ==== | ||
| + | |||
| + | The $http_req_id read-only variable can be used in REQUEST_ROUTE to retrive the unique identifier for a query after sending it or in the HTTP callback route to retrive the id of the query the reply belongs to. Useful mainly in non-transactional context. | ||
| + | |||
| + | ==== $http_req(key) ==== | ||
| + | |||
| + | The $http_req(key) write-only variable can be used to set custom parameters before sending a HTTP query. | ||
| + | |||
| + | **key** can be one of: | ||
| + | * all: if set to $null, resets all the parameters to their default value (the ones defined in modparam) | ||
| + | * hdr: sets/ | ||
| + | * body: sets/ | ||
| + | * method: sets the HTTP method: either " | ||
| + | * timeout: sets the HTTP timeout. (Note, this timeout should be normally less than tm.fr_timer timeout, because transaction timeout has a higher priority over HTTP timeout) | ||
| + | * tls_client_cert: | ||
| + | * tls_client_key: | ||
| + | * tls_ca_path: | ||
| + | * authmethod: Sets the preferred authentication mode for HTTP/HTTPS requests. The value is a bitmap and multiple methods can be used. Note that in this case, the CURL library will make an extra request to discover server-supported authentication methods. You may want to use a specific value. Valid values are: | ||
| + | * 1 - BASIC authentication | ||
| + | * 2 - HTTP Digest authentication | ||
| + | * 4 - GSS-Negotiate authentication | ||
| + | * 8 - NTLM authentication | ||
| + | * 16 - HTTP Digest with IE flavour. | ||
| + | * (Default value is 3 - BASIC and Digest authentication.) | ||
| + | * username: sets the username to use for authenticated requests | ||
| + | * password: sets the password to use for authenticated requests | ||
| + | * suspend: if set to 0 it doesn' | ||
| + | * tcp_keepalive: | ||
| + | * tcp_ka_idle: | ||
| + | * tcp_ka_interval: | ||
| + | |||
| + | ==== Other read-only variables ==== | ||
| + | |||
| + | The following read-only pseudo variables can only be used in the callback routes executed by http_async_query() | ||
| + | |||
| + | === $http_ok === | ||
| + | 1 if cURL executed the request successfully, | ||
| + | |||
| + | === $http_err === | ||
| + | cURL error string if an error occurred, $null otherwise. | ||
| + | |||
| + | === $http_rs === | ||
| + | HTTP status. | ||
| + | |||
| + | === $http_rr === | ||
| + | HTTP reason phrase. | ||
| + | |||
| + | === $http_hdr(Name) === | ||
| + | Value of the Name header (the $(http_hdr(Name)[N]) syntax can also be used, check the SIP $hdr() PV documentation for details). | ||
| + | |||
| + | === $http_mb and $http_ml === | ||
| + | HTTP response buffer (including headers) and length. | ||
| + | |||
| + | === $http_rb and $http_bs === | ||
| + | HTTP response body and body length, | ||
| ===== XMLOPS Pseudo-Variables ===== | ===== XMLOPS Pseudo-Variables ===== | ||
cookbooks/5.3.x/pseudovariables.txt ยท Last modified: 2020/04/06 18:09 by pojogas
Page Tools
