| Jens Geyer | bd52f1a | 2014-07-28 01:25:30 +0200 | [diff] [blame] | 1 | Thrift Haxe Software Library |
| 2 | |
| 3 | License |
| 4 | ======= |
| 5 | |
| 6 | Licensed to the Apache Software Foundation (ASF) under one |
| 7 | or more contributor license agreements. See the NOTICE file |
| 8 | distributed with this work for additional information |
| 9 | regarding copyright ownership. The ASF licenses this file |
| 10 | to you under the Apache License, Version 2.0 (the |
| 11 | "License"); you may not use this file except in compliance |
| 12 | with the License. You may obtain a copy of the License at |
| 13 | |
| 14 | http://www.apache.org/licenses/LICENSE-2.0 |
| 15 | |
| 16 | Unless required by applicable law or agreed to in writing, |
| 17 | software distributed under the License is distributed on an |
| 18 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 19 | KIND, either express or implied. See the License for the |
| 20 | specific language governing permissions and limitations |
| 21 | under the License. |
| 22 | |
| 23 | Using Thrift with Haxe |
| 24 | ======================== |
| 25 | |
| 26 | Thrift requires Haxe 3.1.3. |
| 27 | |
| 28 | To get started, visit the /tutorial/haxe and /test/haxe dirs for examples. |
| 29 | If you are using HIDE, you'll find the HIDE project files in these folders. |
| 30 | |
| 31 | |
| 32 | Current status |
| 33 | ======================== |
| 34 | - tested with Haxe C++ target |
| Jens Geyer | fea00ac | 2014-10-01 02:22:48 +0200 | [diff] [blame] | 35 | - transports: Socket, HTTP (client only), Stream |
| 36 | - protocols: Binary, JSON |
| Jens Geyer | bd52f1a | 2014-07-28 01:25:30 +0200 | [diff] [blame] | 37 | - tutorial client and server available |
| 38 | - cross-test client and server available |
| 39 | |
| 40 | |
| 41 | Further developments |
| 42 | ======================== |
| Jens Geyer | bd52f1a | 2014-07-28 01:25:30 +0200 | [diff] [blame] | 43 | - improve to work with C#, Java and JavaScript Haxe/OpenFL targets |
| 44 | - improve to work with more (ideally all) Haxe/OpenFL targets |
| Jens Geyer | fea00ac | 2014-10-01 02:22:48 +0200 | [diff] [blame] | 45 | - add HTTP server, update tutorial and tests accordingly |
| Jens Geyer | bd52f1a | 2014-07-28 01:25:30 +0200 | [diff] [blame] | 46 | |
| 47 | |
| 48 | Dependencies |
| 49 | ======================== |
| 50 | |
| 51 | Haxe Targets: |
| 52 | Depending on the desired targets, you may have to install the appropriate HaxeLibs |
| 53 | after installing Haxe itself. For example, if you plan to target C#, Java and C++, |
| 54 | enter the following commands after installing Haxe: |
| 55 | |
| Jens Geyer | fea00ac | 2014-10-01 02:22:48 +0200 | [diff] [blame] | 56 | haxelib install hxcpp |
| 57 | haxelib install hxjava |
| 58 | haxelib install hxcs |
| Jens Geyer | bd52f1a | 2014-07-28 01:25:30 +0200 | [diff] [blame] | 59 | |
| 60 | For other targets, please consult the Haxe documentation whether or not any additional |
| 61 | target libraries need to be installed and how to achieve this. |
| 62 | |
| 63 | Haxe Libraries: |
| 64 | - None (at the time of writing) |
| 65 | |
| 66 | |
| 67 | Known restrictions |
| 68 | ======================== |
| 69 | |
| 70 | Although designed with maximum portability in mind, for technical reasons some platforms |
| 71 | may only support parts of the library, or not be compatible at all. |
| 72 | |
| 73 | Javascript: |
| 74 | - tutorial fails to build because of unsupported Sys.args |
| 75 | |