Ufront API Documentation

Ufront is an open source client-server web framework for Haxe. This API documentation includes all the classes used in the various Ufront libraries.

The menu on the left only shows the ufront package, which is where most of the good stuff is.The API documentation for any dependencies is included in the search and in links in the documentation, but is hidden from the menu to avoid clutter.

package haxe

ds
extern
format
io
macro
remoting
rtti
xml
CallStack

Get informations about the call stack.

DynamicAccess

DynamicAccess is an abstract type for working with anonymous structures that are intended to hold collections of objects by the string key.

EnumFlags

A typed interface for bit flags. This is not a real object, only a typed interface for an actual Int. Each flag can be tested/set with the corresponding enum instance. Up to 32 flags can be stored that way.

EnumTools

EnumValueTools

FlatEnum

This type unifies with an enum instance if all constructors of the enum require no arguments.

Function

This type unifies with any function type.

Http

This class can be used to handle Http requests consistently across platforms. There are two intended usages:

IMap

Int32

Int32 provides a 32-bit integer with consistent overflow behavior across all platforms.

Int64

A cross-platform signed 64-bit integer. Int64 instances can be created from two 32-bit words using Int64.make().

Json

Crossplatform JSON API : it will automatically use the optimized native API if available. Use -D haxeJSON to force usage of the Haxe implementation even if a native API is found : this will provide extra encoding features such as enums (replaced by their index) and StringMaps.

Log

Log primarily provides the trace() method, which is invoked upon a call to trace() in haxe code.

PosInfos

PosInfos is a magic type which can be used to generate position information into the output for debugging use.

Serializer

The Serializer class can be used to encode values and objects into a String, from which the Unserializer class can recreate the original representation.

StackItem

Elements return by CallStack methods.

Template

Template provides a basic templating mechanism to replace values in a source String, and to have some basic logic.

Timer

The Timer class allows you to create asynchronous timers on platforms that support events.

Unserializer

The Unserializer class is the complement to the Serializer class. It parses a serialization String and creates objects from the contained data.

Utf8

Since all platforms does not guarantee that String always uses UTF-8 encoding, you can use this crossplatform API to perform operations on such strings.