LlRequestURL

From Second Life Wiki
Jump to: navigation, search

Summary

Function: key llRequestURL( );

Requests one HTTP:// url for use by this script. The http_request event is triggered with the result of the request. HTTP-in uses port 12046.
Returns a handle (a key) used for identifying the result of the request in the http_request event.

Caveats

  • HTTP-in uses port 12046.
  • Use of this function is throttled. Although it has no forced sleep time, too many requests (5 ish) in a short period will cause all further requests to be denied until the script stops requesting urls for at least 1 second. Using an llSleep of 0.6 seconds or greater between each request will prevent you from being throttled.
  • When a region is (re)started all HTTP server URLs are automatically released and invalidated.
  • The number of available URLs is a limited resource, that is to say, a script can only have so many open URLs. See LSL http_server#Resource Limitations for details.
  • When abandoning a URL, release it with llReleaseURL, to avoid leaks. Resetting the script, or deleting the prim will also suffice to release URLs.

Important Issues

~ All Issues ~ Search JIRA for related Bugs
   llRequestURL silently failing on simulator restart

Examples

This script requests a new URL after region restart.

See the discussion page for explanations as to why this particular script never needs to use llReleaseURL().

string url;
key urlRequestId;
 
default
{
    state_entry()
    {
	urlRequestId = llRequestURL();
    }
    on_rez(integer start_param)
    {
	llResetScript();
    }
 
    changed(integer change)
    {
	if (change & (CHANGED_OWNER | CHANGED_INVENTORY))
		llResetScript();
 
	if (change & (CHANGED_REGION | CHANGED_REGION_START | CHANGED_TELEPORT))
		urlRequestId = llRequestURL();
    }
 
    http_request(key id, string method, string body)
    {
	if (id == urlRequestId)
	{
	    if (method == URL_REQUEST_DENIED)
		llOwnerSay("The following error occurred while attempting to get a free URL for this device:\n \n" + body);
 
	    else if (method == URL_REQUEST_GRANTED)
	    {
		url = body;
		llLoadURL(llGetOwner(), "Click to visit my URL!", url);
	    }
	}
    }
}

It's important to keep in mind that if you request another URL, that the old one will not be released, it will remain active. The following script drives home this point.

Try the following code ONLY if you can use all your URLs on your land. Removing the prim/script will release all URLs previous assigned.

// WARNING:
//
//      This script is only for proof-of-concept (demo purposes).
//      DO NOT use it if you don't have the sim owners and/or
//      estate managers OK to test this script.
//      This script can possibly block HTTP communication from and to the sim.
//      ...bringing down all networked vendors and/or similar machines.
//
//      This script allocates all available URLs.
//      Deleting the script and/or derezzing the object containing the script,
//      will release all previously taken URLs.
 
 
default
{
    state_entry()
    {
        llRequestURL();
    }
 
    http_request(key id, string method, string body)
    {
        if (method == URL_REQUEST_DENIED)
            llSetText("No free URLs!", <1.0, 0.0, 0.0>, 1.0);
 
        else if (method == URL_REQUEST_GRANTED)
        {
            llSetText( (string)llGetFreeURLs() + " URLs left\n" + body, <1.0, 1.0, 1.0>, 1.0);
 
            llRequestURL();
        }
        else if (method == "GET")
            llHTTPResponse(id, 200, "Hello there!");
    }
}

This script will, as you can see, use all URLs available on your land because it does not remove the old URLs before requesting a new one.

Just store the old URL in a global variable and release it with llReleaseURL.

Notes

Another comment on resilient programming: getting a global resource, an HTTP listener in this case, should always be considered an operation that can fail for transitory reasons (as well as permanent ones). In this case, LSL folds retryable and permanent errors into the same error status and there's no opportunity for a script writer to distinguish the two cases. But a reasonable way to handle this is sleeping with limited retries before failing hard in the LSL code.
Monty Linden

See Also

Functions

•  llRequestSecureURL
•  llGetFreeURLs
•  llReleaseURL
•  llHTTPResponse
•  llGetHTTPHeader

Articles

•  LSL http server

Deep Notes

History

All Issues

~ Search JIRA for related Issues
   llRequestURL silently failing on simulator restart

Signature

function key llRequestURL();