LlRequestURL - Revision history

Gwyneth Llewelyn: Replaced with , added some wikilinks, cleaned up code to conform to best practices

2023-06-11T11:49:42Z

Replaced <source> with <syntaxhighlight>, added some wikilinks, cleaned up code to conform to best practices

Oz Linden at 20:10, 4 February 2020

2020-02-04T20:10:07Z

← Older revision		Revision as of 13:10, 4 February 2020
Line 5:		Line 5:
	\|return_type=key\|return_subtype=handle		\|return_type=key\|return_subtype=handle
	\|func_footnote=		\|func_footnote=
	\|func_desc=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~~.		\|func_desc=Requests one HTTP:// url for use by this [[script]]. The [[http_request]] [[event]] is triggered with the result of the request.
	\|return_text=used for identifying the result of the request in the [[http_request]] [[event]].		\|return_text=used for identifying the result of the request in the [[http_request]] [[event]].
	\|spec		\|spec
	\|caveats=*HTTP-in uses ~~port 12046~~.		\|caveats=
			*HTTP-in is not on the usual http port number; the url it provided in the http_request event includes the correct port number.
			*Your script (and any client that uses it) should not "validate" the provided URL; in particular, do not assume that it maps to any particular address, or is in any particular domain. These will change during the uplift of Second Life to the cloud, and may be more dynamic following that uplift.
	*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.		*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_request\|HTTP server]] URLs are automatically released and invalidated.		*When a region is (re)started all [[http_request\|HTTP server]] URLs are automatically released and invalidated.

Oz Linden at 16:56, 2 July 2019

2019-07-02T16:56:51Z

← Older revision		Revision as of 09:56, 2 July 2019
Line 18:		Line 18:
	\|constants		\|constants
	\|examples=		\|examples=
			A fully worked out example that shows how to get a URL, register that URL with an external client, and do proper backoff and retry for contacting external services can be found at [[HTTP Server URL Registration]].

	This script requests a new URL after region restart.		This script requests a new URL after region restart.

Tapple Gao: Noted that url's persist across state changes

2018-07-13T01:38:30Z

Noted that url's persist across state changes

← Older revision		Revision as of 18:38, 12 July 2018
Line 14:		Line 14:
	*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.		*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.		*When abandoning a URL, release it with [[llReleaseURL]], to avoid leaks. Resetting the script, or deleting the prim will also suffice to release URLs.
			*Unlike [[llListen\|listeners]], url's persist across state changes

	\|constants		\|constants

Ghost Menjou: It's per script, not per object.

2017-04-23T13:44:35Z

It's per script, not per object.

← Older revision		Revision as of 06:44, 23 April 2017
Line 5:		Line 5:
	\|return_type=key\|return_subtype=handle		\|return_type=key\|return_subtype=handle
	\|func_footnote=		\|func_footnote=
	\|func_desc=Requests one HTTP:// url for use by this [[~~object~~]]. The [[http_request]] [[event]] is triggered with the result of the request. HTTP-in uses port 12046.		\|func_desc=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.
	\|return_text=used for identifying the result of the request in the [[http_request]] [[event]].		\|return_text=used for identifying the result of the request in the [[http_request]] [[event]].
	\|spec		\|spec

Omei Qunhua: Reduce the first example script to the essentials.

2015-12-14T22:22:03Z

Reduce the first example script to the essentials.

← Older revision		Revision as of 15:22, 14 December 2015
Line 17:		Line 17:
	\|constants		\|constants
	\|examples=		\|examples=
	This script requests a new URL after region restart:		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().
	<source lang="lsl2">		<source lang="lsl2">
	string url;		string url;
	key urlRequestId;		key urlRequestId;
	~~key selfCheckRequestId;~~

	~~request_url()~~
	{
	~~llReleaseURL(url);~~
	~~url = "";~~

	~~urlRequestId = llRequestURL();~~
	}

	~~throw_exception(string inputString)~~
	{
	~~key owner = llGetOwner();~~
	~~llInstantMessage(owner, inputString);~~

	~~// yeah, bad way to handle exceptions by restarting.~~
	~~// However this is just a demo script...~~

	~~llResetScript();~~
	}

	default		default
	{		{
			state_entry()
			{
			urlRequestId = llRequestURL();
			}
	on_rez(integer start_param)		on_rez(integer start_param)
	{		{
	llResetScript();		llResetScript();
	}		}

	changed(integer change)		changed(integer change)
	{		{
	if (change & (CHANGED_OWNER \| CHANGED_INVENTORY))		if (change & (CHANGED_OWNER \| CHANGED_INVENTORY))
	llResetScript();		llResetScript();

	~~if (change & (CHANGED_REGION \| CHANGED_REGION_START \| CHANGED_TELEPORT))~~
	~~request_url();~~
	}

	~~state_entry~~()		if (change & (CHANGED_REGION \| CHANGED_REGION_START \| CHANGED_TELEPORT))
	{		urlRequestId = llRequestURL();
	~~request_url~~();
	}		}

	http_request(key id, string method, string body)		http_request(key id, string method, string body)
	{		{
	~~integer responseStatus~~ = ~~400;~~		if (id == urlRequestId)
	~~string responseBody~~ = ~~"Unsupported method";~~		{
			if (method == URL_REQUEST_DENIED)
	if (method == URL_REQUEST_DENIED)		llOwnerSay("The following error occurred while attempting to get a free URL for this device:\n \n" + body);
	~~throw_exception~~("The following error occurred while attempting to get a free URL for this device:\n \n" + body);

	else if (method == URL_REQUEST_GRANTED)		else if (method == URL_REQUEST_GRANTED)
	{		{
	url = body;		url = body;
	~~key owner =~~ llGetOwner();		llLoadURL(llGetOwner(), "Click to visit my URL!", url);
	~~llLoadURL(owner~~, "Click to visit my URL!", url);		}
			}
	~~// check every 5 mins for dropped URL~~
	~~llSetTimerEvent(300.0);~~
	}
	~~else if (method == "GET")~~
	{
	~~responseStatus = 200;~~
	~~responseBody = "Hello world!";~~
	}
	~~// else if (method == "POST") ...;~~
	~~// else if (method == "PUT") ...;~~
	~~// else if (method == "DELETE") { responseStatus = 403; responseBody = "forbidden"; }~~

	~~llHTTPResponse(id, responseStatus, responseBody);~~
	}

	~~http_response(key id, integer status, list metaData, string body)~~
	{
	~~if (id == selfCheckRequestId)~~
	{
	~~// If you're not usually doing this,~~
	~~// now is a good time to get used to doing it!~~
	~~selfCheckRequestId = NULL_KEY;~~

	~~if (status != 200)~~
	~~request_url();~~
	}

	~~else if (id == NULL_KEY)~~
	~~throw_exception("Too many HTTP requests too fast!");~~
	}

	~~timer()~~
	{
	~~selfCheckRequestId = llHTTPRequest(url,~~
	~~[HTTP_METHOD, "GET",~~
	~~HTTP_VERBOSE_THROTTLE, FALSE,~~
	~~HTTP_BODY_MAXLENGTH, 16384],~~
	~~"");~~
	}		}
	}		}

Omei Qunhua: Resetting a script releases URLs, so no need to formally release them before llResetScript()

2015-12-12T23:14:50Z

Resetting a script releases URLs, so no need to formally release them before llResetScript()

← Older revision		Revision as of 16:14, 12 December 2015
Line 13:		Line 13:
	**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.		**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.
	*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.		*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, ~~always~~ release it with [[llReleaseURL]], ~~otherwise it~~ will ~~leak.~~		*When abandoning a URL, release it with [[llReleaseURL]], to avoid leaks. Resetting the script, or deleting the prim will also suffice to release URLs.
	~~{{LSL Tip\|Never ever forget~~ to release ~~a URL again which you have requested!~~ URLs ~~are region resources just like prims~~. ~~If you take them all you can get into big trouble with the sim owner and/or estate managers.}}~~
	\|constants		\|constants
	\|examples=		\|examples=
Line 22:		Line 22:
	key urlRequestId;		key urlRequestId;
	key selfCheckRequestId;		key selfCheckRequestId;

	~~reset_script()~~
	{
	~~llReleaseURL(url);~~
	~~llResetScript();~~
	}

	request_url()		request_url()
Line 45:		Line 39:
	// However this is just a demo script...		// However this is just a demo script...

	~~reset_script~~();		llResetScript();
	}		}

Line 52:		Line 46:
	on_rez(integer start_param)		on_rez(integer start_param)
	{		{
	~~reset_script~~();		llResetScript();
	}		}

Line 58:		Line 52:
	{		{
	if (change & (CHANGED_OWNER \| CHANGED_INVENTORY))		if (change & (CHANGED_OWNER \| CHANGED_INVENTORY))
	~~reset_script~~();		llResetScript();

	if (change & (CHANGED_REGION \| CHANGED_REGION_START \| CHANGED_TELEPORT))		if (change & (CHANGED_REGION \| CHANGED_REGION_START \| CHANGED_TELEPORT))

Strife Onizuka: Maybe 5 per 3 seconds?

2015-09-12T22:36:18Z

Maybe 5 per 3 seconds?

← Older revision		Revision as of 15:36, 12 September 2015
Line 9:		Line 9:
	\|spec		\|spec
	\|caveats=*HTTP-in uses port 12046.		\|caveats=*HTTP-in uses port 12046.
	*~~Using~~ of this function is throttled. Although it has no forced sleep time, too many requests (5 ish) in a short period will cause all ~~farther~~ 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.		*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_request\|HTTP server]] URLs are automatically released and invalidated.		*When a region is (re)started all [[http_request\|HTTP server]] URLs are automatically released and invalidated.
	**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.		**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.
	*URLs are automatically released when the script is reset, or recompiled.
	*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.		*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, always release it with [[llReleaseURL]], otherwise it will leak.		*When abandoning a URL, always release it with [[llReleaseURL]], otherwise it will leak.

NanakoAC Resident: Added information about URL auto release on reset or recompile. This may be a change from old behaviour, it is confirmed to be true at the time of writing

2015-09-09T22:02:50Z

Added information about URL auto release on reset or recompile. This may be a change from old behaviour, it is confirmed to be true at the time of writing

← Older revision		Revision as of 15:02, 9 September 2015
Line 12:		Line 12:
	*When a region is (re)started all [[http_request\|HTTP server]] URLs are automatically released and invalidated.		*When a region is (re)started all [[http_request\|HTTP server]] URLs are automatically released and invalidated.
	**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.		**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.
			*URLs are automatically released when the script is reset, or recompiled.
	*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.		*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, always release it with [[llReleaseURL]], otherwise it will leak.		*When abandoning a URL, always release it with [[llReleaseURL]], otherwise it will leak.

NanakoAC Resident: Added information about throttling, based on testing

2015-09-08T20:18:04Z

Added information about throttling, based on testing

← Older revision		Revision as of 13:18, 8 September 2015
Line 9:		Line 9:
	\|spec		\|spec
	\|caveats=*HTTP-in uses port 12046.		\|caveats=*HTTP-in uses port 12046.
			*Using of this function is throttled. Although it has no forced sleep time, too many requests (5 ish) in a short period will cause all farther 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_request\|HTTP server]] URLs are automatically released and invalidated.		*When a region is (re)started all [[http_request\|HTTP server]] URLs are automatically released and invalidated.
	**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.		**Use [[CHANGED_REGION_START]] to detect this so new URL can be requested.