class haxe.Http
Available on all platforms
This class can be used to handle Http requests consistently across platforms. There are two intended usages:
-
call haxe.Http.requestUrl(url) and receive the result as a String (not available on flash)
-
create a new haxe.Http(url), register your callbacks for onData, onError and onStatus, then call request().
Class Fields
static var PROXY:{port:Int, host:String, auth:{user:String, pass:String}}
Available on cpp, java, neko, php
static function requestUrl(url:String):String
Available on cpp, java, js, neko, php
Makes a synchronous request to url
.
This creates a new Http instance and makes a GET request by calling its request(false) method.
If url
is null, the result is unspecified.
Instance Fields
The url of this
request. It is used only by the request() method and
can be changed in order to send the same request to different target
Urls.
Creates a new Http instance with url
as parameter.
This does not do a request until request() is called.
If url
is null, the field url must be set to a value before making the
call to request(), or the result is unspecified.
(Php) Https (SSL) connections are allowed only if the OpenSSL extension is enabled.
function customRequest(post:Bool, api:Output, ?sock:AbstractSocket, ?method:String):Void
Available on cpp, java, neko, php
function fileTransfer(argname:String, filename:String, file:Input, size:Int, ?mimeType:String):Void
Available on cpp, java, neko, php
function fileTransfert(argname:String, filename:String, file:Input, size:Int, ?mimeType:String):Void
Available on cpp, java, neko, php
Note: Deprecated in 4.0
function onData(data:String):Void
This method is called upon a successful request, with data
containing
the result String.
The intended usage is to bind it to a custom function:
httpInstance.onData = function(data) { // handle result }
function onError(msg:String):Void
This method is called upon a request error, with msg
containing the
error description.
The intended usage is to bind it to a custom function:
httpInstance.onError = function(msg) { // handle error }
function onStatus(status:Int):Void
This method is called upon a Http status change, with status
being the
new status.
The intended usage is to bind it to a custom function:
httpInstance.onStatus = function(status) { // handle status }
function request(?post:Bool):Void
Sends this
Http request to the Url specified by this.url
.
If post
is true, the request is sent as POST request, otherwise it is
sent as GET request.
Depending on the outcome of the request, this method calls the onStatus(), onError() or onData() callback functions.
If this.url
is null, the result is unspecified.
If this.url
is an invalid or inaccessible Url, the onError() callback
function is called.
(Js) If this.async
is false, the callback functions are called before
this method returns.
function setHeader(header:String, value:String):Http
Sets the header identified as header
to value value
.
If header
or value
are null, the result is unspecified.
This method provides a fluent interface.
function setParameter(param:String, value:String):Http
Sets the parameter identified as param
to value value
.
If header
or value
are null, the result is unspecified.
This method provides a fluent interface.
function setPostData(data:String):Http
Available on cpp, flash, java, js, neko, php
Sets the post data of this
Http request to data
.
There can only be one post data per request. Subsequent calls overwrite the previously set value.
If data
is null, the post data is considered to be absent.
This method provides a fluent interface.