package haxe.http
extended by HttpJs, HttpFlash, Http
Available on all platforms
This class can be used to handle Http requests consistently across platforms. There are two intended usages:
haxe.Http.requestUrl(url)
and receive the result as a String
(not available on flash)new haxe.Http(url)
, register your callbacks for onData
, onError
and onStatus
, then call request()
.new(url:String)
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.
read onlyresponseBytes:Null<Bytes>
read onlyresponseData:Null<String>
url:String
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.
addHeader(header:String, value:String):Void
addParameter(name:String, value:String):Void
dynamiconBytes(data:Bytes):Void
This method is called upon a successful request, with data
containing the result String.
httpInstance.onBytes = function(data) { // handle result }
dynamiconData(data:String):Void
This method is called upon a successful request, with data
containing the result String.
httpInstance.onData = function(data) { // handle result }
dynamiconError(msg:String):Void
This method is called upon a request error, with msg
containing the error description.
httpInstance.onError = function(msg) { // handle error }
dynamiconStatus(status:Int):Void
This method is called upon a Http status change, with status
being the new status.
httpInstance.onStatus = function(status) { // handle status }
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()
, onData()
or onBytes()
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.
setHeader(name:String, value:String):Void
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.
setParameter(name:String, value:String):Void
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.
setPostBytes(data:Null<Bytes>):Void
Sets the post data of this
Http request to data
bytes.
There can only be one post data per request. Subsequent calls to this method or to setPostData()
overwrite the previously set value.
If data
is null, the post data is considered to be absent.
This method provides a fluent interface.
setPostData(data:Null<String>):Void
Sets the post data of this
Http request to data
string.
There can only be one post data per request. Subsequent calls to this method or to setPostBytes()
overwrite the previously set value.
If data
is null, the post data is considered to be absent.
This method provides a fluent interface.
© 2005–2020 Haxe Foundation
Licensed under a MIT license.
https://api.haxe.org/haxe/http/HttpBase.html