HTTP Client - Revision history

Andreea: /* Handled message */

2020-11-09T13:35:23Z

‎Handled message

2020-10-28T11:04:34Z

‎Status report

2020-10-28T10:54:27Z

‎Handled message

2020-10-28T10:53:16Z

Update result return description

2020-10-28T10:38:14Z

Updated request message parameters description

2020-10-28T10:04:49Z

Updated config file contents

2019-10-02T11:06:23Z

‎Testing

2019-10-02T11:04:53Z

‎Testing

2019-10-02T11:04:45Z

‎Testing

2019-10-02T11:04:29Z

‎Testing

@@ Line 14: / Line 14: @@
 * '''notify''': Target id for notification. Ignored for synchronous requests
 * '''local_failure_response_async''': Boolean (default: '''false'''). Always emit a notification on local failure (don't return error in handled message).<br>This parameter is ignored for synchronous requests or empty '''notify'''.<br>This parameter may be used by modules using full asynchronous sending without needing to check if the request started.<br>Further message processing by other module(s) will stop if this parameter is set to true.
-* '''http_''': Add header(s) to request from parameters starting with this prefix. This parameter may be repeated to add multiple header.<br>E.g. ''header_X-Hdr=custom'' will add the header ''X-Hdr: custom''
+* '''http_''': Add header(s) to request from parameters starting with this prefix. This parameter may be repeated to add multiple header.<br>E.g. ''http_X-Hdr=custom'' will add the header ''X-Hdr: custom''
 * '''header''': Add header(s) to request. This parameter may be repeated to add multiple header.<br>E.g. ''header=X-Hdr2: custom2'' will add the header ''X-Hdr2: custom2''
 * '''ret_header''': Return header(s) from response. Comma separated list of header name(s).<br>E.g. ret_header=Location will return the ''Location'' header if present in response as ''xhttp_location'' parameter

@@ Line 80: / Line 80: @@
 Status parameters:
 * '''total''': Total number of requests
-* '''maxrequests''': Maximum number of active (accepted) requests
+* '''maxrequests''': Maximum number of active (accepted) requests ever
-* '''maxqueue''': Maximum queue length (asynchronous requests waiting to start)
+* '''maxqueue''': Maximum queue length (asynchronous requests waiting to start) ever
-* '''total_accepted''': Total number of accepted requests
+* '''maxthread_concurrent''': Maximum number of per processing thread concurrent requests ever
 * '''total_sync''': Total number of accepted synchronous requests
 * '''total_async_notify''': Total number of accepted asynchronous requests requiring notification
 * '''total_async_no_notify''': Total number of accepted asynchronous requests not requiring notification
 * '''process_async''': Current number of running asynchronous requests
 * '''process_sync''': Current number of running synchronous requests
 * '''timeout''': The number of timed out requests
-* '''congestion''': The number of congested requests
+* '''congestion''': The number of congested (timeout in queue) requests
-* '''rejected''': The number of rejected requests
+* '''rejected''': The number of rejected (by module) requests
 == Configuration ==

@@ Line 23: / Line 23: @@
 * '''body''': Request body to set (plain character string). Ignored if method is ''GET'' or ''HEAD''
 * '''type''': Optional ''Content-Type'' header contents
-* '''multipart_subtype''': Non empty indicates an application/multipart body. Bodies will be handled as ''body'', ''body.1'' until first not found index.<br>For subsequent bodies the parameters are given with body prefix. E.g. ''body.1.type''
+* '''multipart_subtype''': Non empty indicates a multipart body subtype. E.g. ''related'' will build a ''multipart/related'' body. Bodies will be handled as ''body'', ''body.1'' until first not found index.<br>For subsequent bodies the parameters are given with body prefix. E.g. ''body.1.type''
 * '''body.type''': Alternative for '''type'''. Required for multipart bodies
 * '''body.encoding''': ''hex'' indicates the body value is a hex string containing binary data

@@ Line 42: / Line 42: @@
 == Returning result ==
-=== Success ===
+=== Success. Common parameters ===
 * '''code''': Answer code
 * '''code_text''': Answer text (e.g. ''OK'')
 * '''xcontent_length''': The contents of received ''Content-Length'' header
 * '''xbody_encoding''': ''hex'' if received body contains NULL char(s). The returned body is a string containing HEX chars with no spaces
 The received body is set in message's return value.

@@ Line 10: / Line 10: @@
 * '''url''': Required HTTP URL
 * '''method''': HTTP method to send. Defaults to ''GET'' if missing
 * '''accept''': Optional ''Accept'' header contents
 * '''wait''': Boolean (default: '''false'''). The sender is synchronously waiting for completion
 * '''notify''': Target id for notification. Ignored for synchronous requests
 * '''local_failure_response_async''': Boolean (default: '''false'''). Always emit a notification on local failure (don't return error in handled message).<br>This parameter is ignored for synchronous requests or empty '''notify'''.<br>This parameter may be used by modules using full asynchronous sending without needing to check if the request started.<br>Further message processing by other module(s) will stop if this parameter is set to true.
-The following parameters may be used to override the configured defaults: '''timeout''', '''redirect''', '''agent''', '''max_hdr_length''', '''max_body_length''', '''server_keep_alive''', '''debug'''.<br>
+The following parameters may be used to override the configured defaults: '''timeout''', '''redirect''', '''agent''', '''max_hdr_length''', '''max_body_length''', '''server_keep_alive''', '''ssl_verify_peer''', '''ssl_verify_host''', '''debug'''.<br>
 See ''Configuration'' section for all module parameters allowed to be overridden in handled message.

@@ Line 71: / Line 71: @@
 == Configuration ==
 httpclient.conf
- [general]
+[general]
   ; General settings for the HTTP Client module
@@ Line 84: / Line 84: @@
   ; Allowed interval: 100..600000
   ;timeout=10000
   ; max_hdr_length: integer: Maximum length for received headers
@@ Line 95: / Line 101: @@
   ;max_body_length=65535
-  ; max_requests: integer: Maximum number of concurrent requests (sync or async) handled by the module
+  ; max_requests: integer: Maximum number of requests (sync or async) pending in the module
   ; This parameter is applied on reload
   ; New requests will be rejected by the module when this limit is reached
   ; Minimum allowed value is 100. Defaults to 20000
   ;max_requests=20000
   ; server_keep_alive: boolean: Tell the server we want it to keep the connection alive
@@ Line 105: / Line 116: @@
   ; This parameter is applied on reload and can be overridden in handled message
   ;server_keep_alive=yes
   ; agent: string: User agent to set in request
   ; This parameter is applied on reload and can be overridden in handled message
   ;agent=YATE/${version}
   ; async_priority: keyword: Priority of the thread processing the asynchronous requests