Project

General

Profile

Curl Scol plugin
Scol functions definition

Functions

int _CRcurlRequest (mmachine m)
 _CRcurlRequest : This function create a CURL object
 
int _KILLcurlRequest (mmachine m)
 _KILLcurlRequest : Destroy CURL object
 
int _CALLcurlRequest (mmachine m)
 _CALLcurlRequest : This function execute the CURL object request asynchronously Prototype: fun [ObjCURL fun [ObjCURL u0 S I] u1 u0] ObjCURL
 
int _CALLcurlRequestSync (mmachine m)
 _CALLcurlRequestSync : This function execute the CURL object request and block until the request is finished Prototype: fun [ObjCURL fun [ObjCURL u0 S I] u1 u0] ObjCURL
 
int _SETcurlRequestHeader (mmachine m)
 _SETcurlRequestHeader : This function change the CURL request header content Prototype: fun [ObjCURL [S r1]] ObjCURL
 
int _SETcurlOption (mmachine m)
 _SETcurlOption : This function set CURL options Prototype: fun [ObjCURL I I] ObjCURL
 
int _SETcurlOptionList (mmachine m)
 _SETcurlOptionList : This function set CURL options with a list param Prototype: fun [ObjCURL I [S r1]] ObjCURL
 
int _SETcurlOptionS (mmachine m)
 _SETcurlOptionS : This function set CURL options with a string Prototype: fun [ObjCURL I S] ObjCURL
 
int _SETcurlOptionFile (mmachine m)
 _SETcurlOptionFile : This function set CURL options with a file Prototype: fun [ObjCURL I P] ObjCURL
 
int _ADDcurlFormField (mmachine m)
 _ADDcurlFormField : This function add a form field for Post operation on a CURL object Prototype: fun [ObjCURL S S] ObjCURL
 
int _ADDcurlFileFormField (mmachine m)
 _ADDcurlFileFormField : This function add a file form field for Post operation on a CURL object Prototype: fun [ObjCURL S P] ObjCURL
 

Detailed Description

Scol functions definition

Function Documentation

◆ _ADDcurlFileFormField()

int _ADDcurlFileFormField ( mmachine  m)

_ADDcurlFileFormField : This function add a file form field for Post operation on a CURL object Prototype: fun [ObjCURL S P] ObjCURL

Parameters
ObjCURL: the CURL object
S: the field name
P: the file path
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 543 of file scolplugin.cpp.

◆ _ADDcurlFormField()

int _ADDcurlFormField ( mmachine  m)

_ADDcurlFormField : This function add a form field for Post operation on a CURL object Prototype: fun [ObjCURL S S] ObjCURL

Parameters
ObjCURL: the CURL object
S: the field name
S: the field value
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 502 of file scolplugin.cpp.

◆ _CALLcurlRequest()

int _CALLcurlRequest ( mmachine  m)

_CALLcurlRequest : This function execute the CURL object request asynchronously Prototype: fun [ObjCURL fun [ObjCURL u0 S I] u1 u0] ObjCURL

Parameters
ObjCURL: the CURL object
fun[ObjCURL u0 S I] u1 : callback on receive data
S: the received data
I: the received error, send -1 when proceed, 0 when done, error code otherwise
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 193 of file scolplugin.cpp.

◆ _CALLcurlRequestSync()

int _CALLcurlRequestSync ( mmachine  m)

_CALLcurlRequestSync : This function execute the CURL object request and block until the request is finished Prototype: fun [ObjCURL fun [ObjCURL u0 S I] u1 u0] ObjCURL

Parameters
ObjCURL: the CURL object
fun[ObjCURL u0 S I] u1 : callback on receive data
S: the received data
I: the received error, send -1 when proceed, 0 when done, error code otherwise
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 234 of file scolplugin.cpp.

◆ _CRcurlRequest()

int _CRcurlRequest ( mmachine  m)

_CRcurlRequest : This function create a CURL object

Prototype: fun [Chn S] ObjCURL

Parameters
Chn: channel
S: URL
Returns
ObjCURL : the CURL object if success, NIL otherwise

Definition at line 90 of file scolplugin.cpp.

◆ _KILLcurlRequest()

int _KILLcurlRequest ( mmachine  m)

_KILLcurlRequest : Destroy CURL object

fun [ObjCURL] I

Parameters
ObjCURL: CURL Object to destroy
Returns
I : 0 if success, NIL otherwise

Definition at line 162 of file scolplugin.cpp.

◆ _SETcurlOption()

int _SETcurlOption ( mmachine  m)

_SETcurlOption : This function set CURL options Prototype: fun [ObjCURL I I] ObjCURL

Parameters
ObjCURL: the CURL object
I: the CURL option listed here http://curl.haxx.se/libcurl/c/curl_easy_setopt.html (not all supported)
I: the option value
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 320 of file scolplugin.cpp.

◆ _SETcurlOptionFile()

int _SETcurlOptionFile ( mmachine  m)

_SETcurlOptionFile : This function set CURL options with a file Prototype: fun [ObjCURL I P] ObjCURL

Parameters
ObjCURL: the CURL object
I: the CURL option listed here http://curl.haxx.se/libcurl/c/curl_easy_setopt.html (not all supported)
P: the file
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 461 of file scolplugin.cpp.

◆ _SETcurlOptionList()

int _SETcurlOptionList ( mmachine  m)

_SETcurlOptionList : This function set CURL options with a list param Prototype: fun [ObjCURL I [S r1]] ObjCURL

Parameters
ObjCURL: the CURL object
I: the CURL option listed here http://curl.haxx.se/libcurl/c/curl_easy_setopt.html (not all supported)
[Sr1] : the options list values
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 361 of file scolplugin.cpp.

◆ _SETcurlOptionS()

int _SETcurlOptionS ( mmachine  m)

_SETcurlOptionS : This function set CURL options with a string Prototype: fun [ObjCURL I S] ObjCURL

Parameters
ObjCURL: the CURL object
I: the CURL option listed here http://curl.haxx.se/libcurl/c/curl_easy_setopt.html (not all supported)
S: the options list values
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 410 of file scolplugin.cpp.

◆ _SETcurlRequestHeader()

int _SETcurlRequestHeader ( mmachine  m)

_SETcurlRequestHeader : This function change the CURL request header content Prototype: fun [ObjCURL [S r1]] ObjCURL

Parameters
ObjCURL: the CURL object
[Sr1] : the list of header values without the CRLF, also the first http line used for request method must not be set here
Returns
ObjCURL : return the same ObjCURL, NIL otherwise

Definition at line 273 of file scolplugin.cpp.