Multi Theft Auto: Wiki - User contributions [en]

Template:Modules/cURL/changelog

2014-06-22T11:13:38Z

DutchCaffeine:

==Version 1.4==

* Changed function syntax.
* Cleaned the code up

==Version 1.2==

* Added a data return value to curl_perform, it now returns curlcode, data
* Removed the second argument curl_perform, it now only accepts the curl handle
* fixed curl_init( string url ). It now works correctly

Modules/cURL/curl strerror

2014-06-22T11:12:17Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Returns a string with detailed information of an error.

==Syntax==
<syntaxhighlight lang="lua">
curlStrerror(curl handler, CURLcode code)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler
* '''code''' The curl code

==Returns==
The string containing the error, if the code was not found in the system it will return nil

==Example==
<syntaxhighlight lang="lua">
curl = curlInit();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlSetopt(curl, CURLOPT_URL, curlEscape(curl, "http://mtasa.com/"));
result = curlPerform(curl);
print(curlStrerror(curl, result)); -- Since we know that mta exists, we sure get the text 'No error.'
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl perform

2014-06-22T11:11:20Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Let cURL do his work now, by call this function.

==Syntax==
<syntaxhighlight lang="lua">
curlPerform(curl handler)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Returns==
Returns a curl code, if the code is CURLE_OK then your good. Other wise pass this code to curl_strerror, and then you will know what is going on.
On a success call it will return the data as a second argument.

==Example==
<syntaxhighlight lang="lua">
curl = curlInit();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlSetopt(curl, CURLOPT_URL, curlEscape(curl, "http://mtasa.com/"));
result, data = curlPerform(curl);
if result == CURLE_OK then
print(data)
end
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl escape

2014-06-22T11:10:18Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Escape url's. You wont need this function if you pass the url to curl_init.

==Syntax==
<syntaxhighlight lang="lua">
curlEscape(curl handler, string url)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler
* '''url''' The url you want to escape

==Returns==
The escaped url, if it fails it will return nil

==Example==
<syntaxhighlight lang="lua">
curl = curlInit();
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlSetopt(curl, CURLOPT_URL, curlEscape(curl, "http://mtasa.com/"));
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl cleanup

2014-06-22T11:09:40Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Cleans up the curl handle.

==Syntax==
<syntaxhighlight lang="lua">
curlCleanup(curl handler)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Returns==
Nothing usefull

==Example==
<syntaxhighlight lang="lua">
curl = curlInit("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlPerform(curl);
curlCleanup(curl);
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl pause

2014-06-22T11:08:59Z

DutchCaffeine:

{{Modules/cURL/func_page|
description = Pause a request or result|
syntax = <syntaxhighlight lang="lua">CURLcode curlPause(CURL handler, int bitmask)</syntaxhighlight>|
required_arguments = * '''handler''' The curl handler
* '''bitmask''' An integer representing what you want to pause. Read more about this [[Modules/cURL/variables/CURLPAUSE|here]]|
optional_arguments = None|
returns = Returns a CURLcode, if everything is oke it returns CURLE_OK|
example = <syntaxhighlight lang="lua">
curlPause( curl, CURLPAUSE_RECV );
curlPerform( ... );
</syntaxhighlight>
}}

Modules/cURL/curl setopt

2014-06-22T11:08:20Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Set an curl option.

==Syntax==
<syntaxhighlight lang="lua">
curlcode curlSetopt(curl handler, curloption option, bool/number/string value)
</syntaxhighlight>

==Required arguments==
* '''handler''' The curl handler.
* '''option''' An curl option, al the options are found [[Modules/cURL/CURLOPT|here]]
* '''value''' The value, this can be a string, number or boolean. At the [[Modules/cURL/CURLOPT|curl option list]] you can find wich option needs a string, number or boolean.

==Returns==
Returns a curlcode. Nevermind it for now, i even don't know what it is. But it returns it.

==Example==
<syntaxhighlight lang="lua">
curl = curlInit("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlSetopt(curl, CURLOPT_POST, true);
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl close

2014-06-22T11:07:35Z

DutchCaffeine:

__NOTOC__
{{ModuleFunction|cURL}}
Closes the curl engine.

==Syntax==
<syntaxhighlight lang="lua">
curlClose(curl handler)
</syntaxhighlight>

==Required arguments==
* '''curl''' The curl handler

==Returns==
True on succes, false otherwise

==Example==
<syntaxhighlight lang="lua">
curl = curlInit("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
curlClose(curl);
end
</syntaxhighlight>

==See also==
{{Modules/cURL/functions}}

Modules/cURL/curl init

2014-06-22T11:06:57Z

DutchCaffeine:

{{Modules/cURL/func_page|
description = Initialize the curl engine.|
syntax = <syntaxhighlight lang="lua">curl curlInit([string url])</syntaxhighlight>|
required_arguments = *There are no required arguments.|
optional_arguments = * '''url''' The url which you want to connect too.|
returns = A valid curl handler on succes, otherwise it returns false|
example = <syntaxhighlight lang="lua">
curl = curlInit("http://mtasa.com/");
if not curl then
outputDebugString("Can't connect to http://mtasa.com/ with cURL");
else
-- lets do something here.
end
</syntaxhighlight>
}}

Modules/cURL

2014-06-22T11:06:01Z

DutchCaffeine:

{{Module_Info|
name = MTA Curl |
version = 1.2 |
author = [[User:mrdejong|Alexander de Jong (mrdejong)]] |
module_website = ''[https://github.com/mrdejong/mta_curl Here]'' |
download_link = ''[https://dl.dropboxusercontent.com/u/10711598/mta_curl/1.4/mta_curl_win32.zip]'' |
license = [http://www.opensource.org/licenses/bsd-license.php BSD] |
written_in = C++ |
operating_system = Windows|
compatible_with = 1.3.0, 1.3.1, 1.3.2, 1.3.5 |
}}
MTA Curl module is a handy module to make restful api web calls. You could do everything with it.

The module is based on php cURL module.

If you found any bugs, please post them on the [[https://github.com/mrdejong/mta_curl/issues|github page]]

You can find the source at the [[https://github.com/mrdejong/mta_curl|github repository]]

Update 22-6-2014

Released version 1.4;

This release changed the function name syntax to adobt the mta syntax.

==cURL functions==
{{Modules/cURL/functions}}

==cURL variables==
{{Modules/cURL/variables}}

[[Category:Modules]]

[[ru:Modules/cURL]]

==Changelog==
{{Modules/cURL/changelog}}

Template:Modules/cURL/functions

2014-06-22T11:05:05Z

DutchCaffeine:

Modules/cURL

2014-06-22T11:03:41Z

DutchCaffeine:

{{Module_Info|
name = MTA Curl |
version = 1.2 |
author = [[User:mrdejong|Alexander de Jong (mrdejong)]] |
module_website = ''[https://github.com/mrdejong/mta_curl Here]'' |
download_link = ''[https://dl.dropboxusercontent.com/u/10711598/mta_curl/1.4/mta_curl_win32.zip]'' |
license = [http://www.opensource.org/licenses/bsd-license.php BSD] |
written_in = C++ |
operating_system = Windows|
compatible_with = 1.3.0, 1.3.1, 1.3.2, 1.3.5 |
}}
MTA Curl module is a handy module to make restful api web calls. You could do everything with it.

The module is based on php cURL module.

If you found any bugs, please post them on the [[https://github.com/mrdejong/mta_curl/issues|github page]]

You can find the source at the [[https://github.com/mrdejong/mta_curl|github repository]]

Update 27-5-2013

I released the version 1.2, this build is not yet available for linux.

Most important update is how the module works the result data from a call. Please check out curl_perform function to see how you retrieve the data from a call.

==cURL functions==
{{Modules/cURL/functions}}

==cURL variables==
{{Modules/cURL/variables}}

[[Category:Modules]]

[[ru:Modules/cURL]]

==Changelog==
{{Modules/cURL/changelog}}