wiki:WrapperCode

iRail.be wrappers

Wrappers are pieces of code for an API. If you want to build an application on iRail's API, you can reuse these code snippets and start coding right away, without bothoring about asynchronous calls and XML parsing.

  •  .NET Wrapper - .NET wrapper by Dieter De Preester
  •  Java Wrapper - Java wrapper by Pieter Colpaert
  • Action Script 3 - Action Script 3 wrapper by Joris Timmerman.
  •  Action script - Action Script ? Wrapper by Pascal Van Hecke
  •  PHP Wrapper - PHP wrapper by Quentin Kaiser
  •  Qt Wrapper - the Qt-client API library, currently not a separate project but organised as an independant reusable codebase within the BeTrains.Qt project.
  •  JavaScript Standalone - the JavaScript API wrapper as part of the Web project. Will be moved to it's own project soon. By Mathias Baert. Intended for mobile, where including big libraries is expensive.
  •  JavaScript jQuery - jQuery wrapper, test cases and live example on  http://devel.datif.be/jquery.irail/ By Tim Esselens
  •  Perl - Perl HTTP::Request, Response Wrapper. Can be used in API mode or standalone in your project as req/response parser By Tim Esselens
  •  Objective-C - Objective-C wrapper by Ben Van Houtven

Feature Matrix

This table lists the implementation status of the several iRail API wrappers and libraries.

  • "DONE" means that it is implemented and relatively bug-free.
  • "MOSTLY" means that it is implemented but has some known bugs.
  • "WIP" means that someone has started on the initial implementation.
  • "N/A" means that the feature will not be implemented.
  • "TODO" means that the implementation is incomplete and nobody is working on it.
  • "UNKNOWN" means that the current status of this item isn't known.

If you're the maintainer of any of this code, please update these when you can, especially UNKNOWN slots.

stations

connections

liveboard

vehicles

error handling

.NET

UNKNOWN

UNKNOWN

UNKNOWN

UNKNOWN

UNKNOWN

Java

DONE

DONE

DONE

DONE

MOSTLY

ActionScript 3

DONE

DONE

DONE

DONE

General IRailErrorEvent to catch API errors3

ActionScript

UNKNOWN

UNKNOWN

UNKNOWN

UNKNOWN

UNKNOWN

PHP

DONE

DONE

DONE

DONE

MOSTLY

Qt

DONE

DONE

MOSTLY

MOSTLY

TODO1

JavaScript Standalone

MOSTLY3

DONE

DONE

MOSTLY3

MOSTLY2

JavaScript jQuery

DONE

DONE

DONE

DONE

DONE

Perl

DONE

DONE

DONE

DONE

DONE

Objective-C

DONE

DONE

DONE

DONE

WIP

1 Works in a traditional manner (bool error && QString errorString), but will be made to use exceptions which export useful debug information.
2 Error objects returned by server are handled, connection problems are still TODO
3 To be tested