Skip to content

A port of the RPC service classes from Apache Flex (formerly Adobe Flex) to Feathers UI for Haxe and OpenFL

License

Notifications You must be signed in to change notification settings

feathersui/feathersui-rpc-services

Repository files navigation

RPC Services for Feathers UI

A port of the RPC service classes from Apache Flex (formerly Adobe Flex) to Feathers UI for Haxe and OpenFL.

Contains the following service classes:

  • HTTPService: Load data from a URL as XML, simple string text, URL variables, or JSON.
  • RemoteObject: Share the same typed objects on server and client using binary AMF.

Contains the following low-level messaging classes:

  • Producer: Send messages to a destination.
  • Consumer: Subscribe to messages from a destination.

Compatibility Notes

RemoteObject

Instead of adding [RemoteClass(alias="com.example.MyClass")] metadata to a class, call the openfl.Lib.registerClassAlias() function to register each type when the application initializes.

Lib.registerClassAlias("com.example.MyClass", MyClass);

HTTPService

The resultFormat property includes two new formats:

  • RESULT_FORMAT_JSON: Parses the server response as JSON, returning an anonymous structure. Supported on all targets.
  • RESULT_FORMAT_HAXE_XML: Returns an instance of Haxe's Xml class. Supported on all targets.

The RESULT_FORMAT_E4X and RESULT_FORMAT_XML values will throw an exception on most targets. These formats are supported on the flash and air targets only. Using the new RESULT_FORMAT_HAXE_XML instead is recommended.

Unsupported Service Types

The following services have not yet been ported to Haxe and Feathers UI.

  • WebService: Provides access to SOAP-based web services on remote servers.
  • HTTPMultiService: Represents a collection of HTTP operations.

If you need either of these service types, please create a feature request.

Minimum Requirements

  • Haxe 4.1
  • OpenFL 9.2
  • Feathers UI 1.0

Installation

Run the following command in a terminal to install feathersui-rpc-services from Haxelib.

haxelib install feathersui-rpc-services

Project Configuration

After installing the library above, add it to your OpenFL project.xml file:

<haxelib name="feathersui-rpc-services" />

Documentation