Share this page
Registers the next action function as the beginning of an Asynchronous Conversation
An Asynchronous Conversation is a series of related web tasks, including tasks caused by redirection. An Asynchronous Conversation starts with the request for the desired response, includes all the requests and responses that are caused by this request (authentication, redirection, and so on) and ends when the desired response is received or when the series of interactions is canceled. if the function has requests with the specified URL.
int web_reg_async_attributes( "ID=id", "URL[/RE][/IC]=URL_or_RegEx_Pattern", ["Pattern=None|Push|Poll|LongPoll", ["PollIntervalMs=integer"]], ["XMLHttpRequest=No|Async|Sync",] ["CrossStep=No|Yes",] ["RequestCB=function_name",] ["ResponseHeadersCB=function_name",] ["ResponseBodyBufferCB=function_name",] ["ResponseCB=function_name",] LAST);
| Argument | Description |
|---|---|
| ID | The Conversation ID. |
| URL | The full absolute URL, exactly as expected in the next action function. If /RE is specified, the URL can be a regular expression. See Regular Expressions. If /IC is specified, the match is not case sensitive. |
| Pattern | One of None, Push, Poll, or LongPoll. See Asynchronous Conversation Patterns | .
| PollIntervalMs | The number of milliseconds to wait after the end of one poll instance, before another instance can be started. |
| XMLHttpRequest | Sets whether or not the task is handled as a javascript XMLHttpRequest and handled asynchronously to other tasks. One of If the Pattern is None or Push, the default is No. If the Pattern is Poll or LongPoll, the default is Async. |
| CrossStep | If Yes, the steps can end without waiting for the server response for the specified URL to complete. Yes or No. The default is Yes for all Pattern values except None. |
| RequestCB | The name of a user-coded C callback function. The specified function is invoked once for each conversation task. The function and can modify the URL and the request body. See Request Callback |
| ResponseHeadersCB | The name of a user-coded C callback function. The specified function is invoked at most once for each response, when all response headers have been received. |
| ResponseBodyBufferCB | The name of a user-coded C callback function. The specified function is invoked zero or more times for each response body buffer received. It is invoked with data extracted from the last read buffer, and also invoked with all response body accumulated to this point. It is also invoked once with empty data when the response has ended. |
| ResponseCB | The name of a user-coded C callback function. The specified function is invoked once at the end of a conversation, with the accumulated response headers and body of the last request in the conversation. If the last request did not return a response, the callback function is invoked and passed an empty string as the callback function argument. |
| LAST | A marker that indicates the end of the argument list. |
Return Values
This function returns LR_PASS (0) if the registration succeeded.
Parameterization
The values of keyword-value pairs can be parameterized. For example, "ALT={altParam}".General Information
The URL argument is not necessarily the primary URL of the next action function. For example, it can be a redirection or a resource. The Conversation registered will be that specified by the URL argument.
