CallRemote - Revision history

FileEX: /* See Also */

2024-09-06T22:45:59Z

StrixG at 18:07, 26 December 2017

2017-12-26T18:07:34Z

← Older revision		Revision as of 18:07, 26 December 2017
Line 42:		Line 42:

	==Example==		==Example==
	This example shows you how you can call a PHP page from a ~~lua~~ script. It just adds two numbers passed to it by the script and outputs these in the chat box.		This example shows you how you can call a PHP page from a Lua script. It just adds two numbers passed to it by the script and outputs these in the chat box.

	'''PHP:''' (for the page that Lua expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')		'''PHP:''' (for the page that Lua expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
Line 50:		Line 50:
	mta::doReturn($input[0] + $input[1]);		mta::doReturn($input[0] + $input[1]);
	</syntaxhighlight>		</syntaxhighlight>
	'''~~LUA~~:'''		'''Lua:'''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- result is called when the function returns		-- result is called when the function returns
Line 69:		Line 69:
	'''Example 2:''' This example shows how you can join up multiple servers so they can share chat messages.		'''Example 2:''' This example shows how you can join up multiple servers so they can share chat messages.

	'''~~Meta~~.xml'''		'''meta.xml'''
	First, add ''outputChatBoxRemote'' as an HTTP exported function in your resource's meta.xml:		First, add ''outputChatBoxRemote'' as an HTTP exported function in your resource's meta.xml:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
Line 75:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>

	'''~~LUA~~:''' Next, add this to a server-side script in your resource:		'''Lua:''' Next, add this to a server-side script in your resource:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Remote function set with callRemote 'functionName' argument		-- Remote function set with callRemote 'functionName' argument

StrixG at 18:06, 26 December 2017

2017-12-26T18:06:57Z

← Older revision		Revision as of 18:06, 26 December 2017
Line 44:		Line 44:
	This example shows you how you can call a PHP page from a lua script. It just adds two numbers passed to it by the script and outputs these in the chat box.		This example shows you how you can call a PHP page from a lua script. It just adds two numbers passed to it by the script and outputs these in the chat box.

	'''PHP:''' (for the page that ~~LUA~~ expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')		'''PHP:''' (for the page that Lua expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
	<syntaxhighlight lang="lua">[php]		<syntaxhighlight lang="lua">[php]
	include( "mta_sdk.php" );		include( "mta_sdk.php" );

Ccw at 17:09, 6 April 2017

2017-04-06T17:09:25Z

← Older revision		Revision as of 17:09, 6 April 2017
Line 13:		Line 13:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool callRemote ( string host[, int connectionAttempts = 10 ], string resourceName, string functionName, callback callbackFunction, [ arguments... ] )		bool callRemote ( string host[, string queueName = "default" ][, int connectionAttempts = 10, int connectTimeout = 10000 ], string resourceName, string functionName, callback callbackFunction, [ arguments... ] )
	</syntaxhighlight>		</syntaxhighlight>
	'''OR'''		'''OR'''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool callRemote ( string URL[, int connectionAttempts = 10 ], callback callbackFunction, [ arguments... ] )		bool callRemote ( string URL[, string queueName = "default" ][, int connectionAttempts = 10, int connectTimeout = 10000 ], callback callbackFunction, [ arguments... ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 29:		Line 29:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''~~arguments~~:''' ~~Any arguments you may want~~ to ~~pass to the function when it is called~~. Any ~~number of arguments of~~ can be ~~specified~~, ~~each being passed to~~ the ~~designated function~~. ~~Most data types can be passed~~, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).		{{New items\|4.0153\|1.5.3-9.11270\|
			*'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
			}}
	{{New_feature\|3.0139\|1.3.1\|		{{New_feature\|3.0139\|1.3.1\|
	*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 6 seconds. Therefore, the default setting of 10 connection attempts means it will be 60 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 12 seconds''		*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 6 seconds. Therefore, the default setting of 10 connection attempts means it will be 60 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 12 seconds''
			*'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out
	}}		}}
			*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function. Most data types can be passed, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).

	===Returns===		===Returns===
Line 128:		Line 132:
	{{ChangelogHeader}}		{{ChangelogHeader}}
	{{ChangelogItem\|1.3.1-9.04605\|Added connectionAttempts argument}}		{{ChangelogItem\|1.3.1-9.04605\|Added connectionAttempts argument}}
			{{ChangelogItem\|1.5.3-9.11270\|Added queueName argument}}

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

AlexTMjugador: Added link to Community Resources article

2016-06-23T09:08:52Z

Added link to Community Resources article

← Older revision		Revision as of 09:08, 23 June 2016
Line 6:		Line 6:

	You can use the [[PHP SDK]] to create PHP pages that can be called by this function. See the PHP SDK page for an example.		You can use the [[PHP SDK]] to create PHP pages that can be called by this function. See the PHP SDK page for an example.

			In addition, it is possible to use this function to get information about a resource in the MTA community, besides other things. Check out the [[Community Resources]] article.

	In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.		In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

Ccw at 11:35, 21 April 2016

2016-04-21T11:35:18Z

← Older revision		Revision as of 11:35, 21 April 2016
Line 71:		Line 71:
	'''LUA:''' Next, add this to a server-side script in your resource:		'''LUA:''' Next, add this to a server-side script in your resource:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			-- Remote function set with callRemote 'functionName' argument
			-- Called from/on remote servers
	function outputChatBoxRemote ( playerName, message, type, serverport )		function outputChatBoxRemote ( playerName, message, type, serverport )
	~~if serverport ~= getServerPort() then~~		outputChatBox ( "From " .. playerName .. " on " .. serverport .. ": " .. message )
	outputChatBox ( "From " .. playerName .. " on " .. serverport .. ": " .. message )		return "hello sailor"
	~~end~~
	end		end

	function ~~playerChatCallback~~()		-- Callback set with callRemote 'callbackFunction' argument
			-- Called on the local server when callRemote has completed successfully or with errors
			function finishedCallback( responseData, errno )
			responseData = tostring(responseData)
			if responseData == "ERROR" then
			outputDebugString( "callRemote: ERROR #" .. errno )
			elseif responseData ~= "hello sailor" then
			outputDebugString( "callRemote: Unexpected reply: " .. responseData )
			else
			-- callRemote completed successfully
			end
	end		end

	function playerChat ( message, type )		function playerChat ( message, type )
	callRemote ( "play.mtabeta.com:33004", getResourceName(getThisResource()), "outputChatBoxRemote", ~~playerChatCallback~~, getPlayerName(source), message, type, getServerPort() )		callRemote ( "play.mtabeta.com:33004", getResourceName(getThisResource()), "outputChatBoxRemote", finishedCallback, getPlayerName(source), message, type, getServerPort() )
	callRemote ( "play.mtabeta.com:33005", getResourceName(getThisResource()), "outputChatBoxRemote", ~~playerChatCallback~~, getPlayerName(source), message, type, getServerPort() )		callRemote ( "play.mtabeta.com:33005", getResourceName(getThisResource()), "outputChatBoxRemote", finishedCallback, getPlayerName(source), message, type, getServerPort() )
	callRemote ( "play.mtabeta.com:33006", getResourceName(getThisResource()), "outputChatBoxRemote", ~~playerChatCallback~~, getPlayerName(source), message, type, getServerPort() )		callRemote ( "play.mtabeta.com:33006", getResourceName(getThisResource()), "outputChatBoxRemote", finishedCallback, getPlayerName(source), message, type, getServerPort() )
	end		end
	addEventHandler ( "onPlayerChat", getRootElement(), playerChat )		addEventHandler ( "onPlayerChat", getRootElement(), playerChat )

Ccw at 20:59, 27 April 2013

2013-04-27T20:59:55Z

← Older revision		Revision as of 20:59, 27 April 2013
Line 23:		Line 23:
	*'''functionName:''' This is a string with the name of the function which you want to call.		*'''functionName:''' This is a string with the name of the function which you want to call.
	*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.		*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
	*'''callbackFunction:''' This is the function that should receive the data returned from the remote function call. The argument list should match the format of the data returned. The callback function will be passed a string containing "ERROR" followed by an integer indicating the error code when an error occurs calling the function. A list of error codes can be found ~~on the [http://curl.haxx.se/libcurl/c/libcurl-errors.html cURL website~~].		*'''callbackFunction:''' This is the function that should receive the data returned from the remote function call. The argument list should match the format of the data returned. The callback function will be passed a string containing "ERROR" followed by an integer indicating the error code when an error occurs calling the function. A list of error codes [[Template:Error_codes_for_callRemote_and_fetchRemote \|can be found here]].

	===Optional Arguments===		===Optional Arguments===

Ccw at 02:46, 7 September 2012

2012-09-07T02:46:26Z

← Older revision		Revision as of 02:46, 7 September 2012
Line 29:		Line 29:
	*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function. Most data types can be passed, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).		*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function. Most data types can be passed, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).
	{{New_feature\|3.0139\|1.3.1\|		{{New_feature\|3.0139\|1.3.1\|
	*'''connectionAttempts:''' Number of times to retry if the remote host does not respond.		*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 6 seconds. Therefore, the default setting of 10 connection attempts means it will be 60 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 12 seconds''
	}}		}}

Ccw at 05:55, 6 September 2012

2012-09-06T05:55:13Z

← Older revision		Revision as of 05:55, 6 September 2012
Line 57:		Line 57:
	addNumbers ( 123, 456 ) -- call the function		addNumbers ( 123, 456 ) -- call the function
	</syntaxhighlight>		</syntaxhighlight>


	<hr>		<hr>
Line 107:		Line 108:
	</group>		</group>
	<acl name="InRPC">		<acl name="InRPC">
	~~<right name="general.http" access="true" />~~		<right name="resource.examplechat.http" access="true" />
	<right name="resource.examplechat" access="true~~" />~~
	~~<right name="resource.resourcebrowser" access="false" />~~
	~~<right name="resource.webstats" access="false" />~~
	~~<right name="resource.webmap" access="false" />~~
	~~<right name="resource.webadmin" access="false" />~~
	~~<right name="resource.scoreboard" access="false" />~~
	~~<right name="resource.runcode" access="false" />~~
	~~<right name="resource.resourcemanager" access="false" />~~
	~~<right name="resource.mapmanager" access="false" />~~
	~~<right name="resource.admin" access="false" />~~
	~~<right name="resource.elementbrowser" access="false" />~~
	~~<right name="resource.easytext" access="false~~" />
	</acl>		</acl>
	</syntaxhighlight>		</syntaxhighlight>
	'''Important Note''': ''When enabling 'general.http' on an ACL which has a user with no password (i.e. user.* or user.guest or user.http_guest), it is essential that you explicitly block access to resources that contain exported http functions.''

	==Changelog==		==Changelog==

Ccw at 05:45, 6 September 2012

2012-09-06T05:45:32Z

← Older revision		Revision as of 05:45, 6 September 2012
Line 11:		Line 11:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool callRemote ( string host, string resourceName, string functionName, callback callbackFunction, [ arguments... ] )		bool callRemote ( string host[, int connectionAttempts = 10 ], string resourceName, string functionName, callback callbackFunction, [ arguments... ] )
	</syntaxhighlight>		</syntaxhighlight>
	'''OR'''		'''OR'''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool callRemote ( string URL, callback callbackFunction, [ arguments... ] )		bool callRemote ( string URL[, int connectionAttempts = 10 ], callback callbackFunction, [ arguments... ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 28:		Line 28:
	{{OptionalArg}}		{{OptionalArg}}
	*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function. Most data types can be passed, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).		*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function. Most data types can be passed, including tables. The only values that cannot be passed are 'userdata' values such as xmlnodes - elements and resources can be passed though may be misinterpreted on other game servers (or cause warnings).
			{{New_feature\|3.0139\|1.3.1\|
			*'''connectionAttempts:''' Number of times to retry if the remote host does not respond.
			}}

	===Returns===		===Returns===
Line 120:		Line 123:
	</syntaxhighlight>		</syntaxhighlight>
	'''Important Note''': ''When enabling 'general.http' on an ACL which has a user with no password (i.e. user.* or user.guest or user.http_guest), it is essential that you explicitly block access to resources that contain exported http functions.''		'''Important Note''': ''When enabling 'general.http' on an ACL which has a user with no password (i.e. user.* or user.guest or user.http_guest), it is essential that you explicitly block access to resources that contain exported http functions.''

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.3.1-9.04605\|Added connectionAttempts argument}}

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

← Older revision		Revision as of 22:45, 6 September 2024
Line 135:		Line 135:

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions\|server}}