Class Index | File Index

Classes


Class Curl

This class represents an interface to the program 'curl'. Note that it currently only implements the minimum required interface but it can easily be extended. To send a http request, create an instance with the address and (if required) username and password as argument.
Defined in: Curl.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Curl()
Field Summary
Field Attributes Field Name and Description
 
Data of the post/get request
Method Summary
Method Attributes Method Name and Description
 
send(block)
Send the request.
Class Detail
Curl()

Author: Thomas Bretz.
    var curl = new Curl("user:password@www.server.com/path/index.html");

    // You can add data with
    curl.data.push("argument1=value1");
    curl.data.push("argument2=value3");

    // Issue the request
    var ret = curl.send();
Field Detail
{Array[String]} data
Data of the post/get request
Method Detail
{Object} send(block)
Send the request. This calles the 'curl' program. For further details, e.g. on the return value, see the corresponding man page.
Parameters:
{Boolean} block Optional, Default: true
This parameter specifies whether the pipe should be closed, which means that a blocking wait is performed until the 'mail' program returns, or the pipe will be closed automatically in the background when the 'curl' program has finished. Note, that if the calling program terminates, maybe this call will never succeed.
Returns:
{Object} An object with three properties is returned. 'cmd' contains the command issued 'data' contains the data returned from the server in case of success, some error string returned by curl otherwise. 'rc' is an integer and the return code of 'curl'

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Sep 18 2016 20:50:08 GMT+0100 (WEST)