Web

package neko

Available on macro, neko

This class is used for accessing the local Web server and the current client request and information.

Static variables

static read only isModNeko:Bool

static read only isTora:Bool

Static methods

static cacheModule (f:Void ‑> Void):Void

Set the main entry point function used to handle requests. Setting it back to null will disable code caching.

static flush ():Void

Flush the data sent to the client. By default on Apache, outgoing data is buffered so this can be useful for displaying some long operation progress.

@:has_untyped static getAuthorization ():{user:String, pass:String}

Returns an object with the authorization sent by the client (Basic scheme only).

@:has_untyped static getClientHeader (k:String):String

Retrieve a client header value sent with the request.

static getClientHeaders ():List<{value:String, header:String}>

Retrieve all the client headers.

static getClientIP ():String

Surprisingly returns the client IP address.

@:has_untyped static getCookies ():Map<String, String>

Returns an hashtable of all Cookies sent by the client. Modifying the hashtable will not modify the cookie, use setCookie instead.

static getCwd ():String

Get the current script directory in the local filesystem.

static getHostName ():String

Returns the local server host name.

static getMethod ():String

Get the HTTP method used by the client. This API requires Neko 1.7.1+.

static getMultipart (maxSize:Int):Map<String, String>

Get the multipart parameters as an hashtable. The data cannot exceed the maximum size specified.

static getParamValues (param:String):Array<String>

Returns an Array of Strings built using GET / POST values. If the URL contains the parameters [a[]=foo;a[]=hello;a[5]=bar;a[3]=baz] then neko.Web.getParamValues("a") will return ["foo","hello",null,"baz",null,"bar"]

@:has_untyped static getParams ():StringMap<String>

Returns the GET and POST parameters.

static getParamsString ():String

Returns all the GET parameters String.

static getPostData ():String

Returns all the POST data. POST Data is always parsed as being application/x-www-form-urlencoded and is stored into the getParams hashtable. POST Data is maximimized to 256K unless the content type is multipart/form-data. In that case, you will have to use getMultipart or parseMultipart methods.

static getURI ():String

Returns the original request URL (before any server internal redirections)

@:has_untyped static logMessage (msg:String):Void

Write a message into the web server log file. This API requires Neko 1.7.1+.

@:has_untyped static parseMultipart (onPart:String ‑> String ‑> Void, onData:Bytes ‑> Int ‑> Int ‑> Void):Void

Parse the multipart data. Call onPart when a new part is found with the part name and the filename if present and onData when some part data is read. You can this way directly save the data on hard drive in the case of a file upload.

@:has_untyped static redirect (url:String):Void

Tell the client to redirect to the given url ("Location" header)

@:has_untyped static setCookie (key:String, value:String, ?expire:Date, ?domain:String, ?path:String, ?secure:Bool, ?httpOnly:Bool):Void

Set a Cookie value in the HTTP headers. Same remark as setHeader.

@:has_untyped static setHeader (h:String, v:String):Void

Set an output header value. If some data have been printed, the headers have already been sent so this will raise an exception.

static setReturnCode (r:Int):Void

Set the HTTP return code. Same remark as setHeader.