APE (Ajax push engine)

 

Translation: linvo

Please indicate the source of the post!

Http://www.ape-project.org

====================================

 

Getting started with ape

You will find on this page all the informations you need to get started with the ape project. You were wondering how to use ape? This place is for you.

Don't hesitate to join our IRC channel to ask questions: # ape-project@irc.freenode.net

Ape startup

This page contains all the information you need to start using the ape project. You want to know how to use ape? We have prepared for you.

Join our IRC channel to ask questions, don't hesitate: # ape-project@irc.freenode.net

 

What is ape?

APE (Ajax push engine) is an open source technology allowing you to do real time data streaming through a Web browser with no applets and no plugins. the project is divided in two part, the ape server and the ape JavaScript framework.

The ape server written in the C language enables data to be pushed to rich Internet application, while the ape JavaScript framework (JSF) receive and send back data, deal them and display them.

What is ape?

APE (Ajax push engine) is an open source technology that can help you implement real-time data stream transmission through Web Browsers without any plug-ins or small applications. This project is divided into two parts: the ape server and the ape JavaScript framework.

The ape Server is a program written in C language that supports pushing data to rich Internet applications. The ape JavaScript framework (JSF) receives and sends data and processes and displays them.

 

What do I need to start using ape?

The first thing you need to start using ape is to have knowledge in JavaScript programming.

Moreover, you will need a Linux dedicated server in order to install the ape server. (for now, the ape server only installon Linux 2.6.16 + kernel)

Preparation before using ape

Before using ape, you must have some knowledge about JavaScript programming.

In addition, you need a Linux server to install the ape server. (Currently, the ape server only supports Linux kernel 2.6.16 or later)

 

How do I run my own Ape server?

There are two different ways to use the ape server on a dedicated server:

Ape has his own dedicated IP in order to use port 80 (see: how to configure the ape server on port 80 ?)

Ape is used on a server where it gets along with Apache (see: how to configure the ape server with Apache ?)

Once you know what option you cocould (or want) to use, you'll need to download the lastest build of the ape server, and follow the setup manual. within few steps you will be able to start creating your own real time web application!

Notice that the first choice is highly more scalable (since data are not proxied through Apache ).

How can I run my ape server?

There are two different ways to run the ape Server:

Ape uses its own IP address to use port 80 (see here: how to configure the ape server on port 80 ?)

Ape is used on a server with Apache (see here: how to configure the ape server through Apache ?)

Once you know the options you want to use, you need to download the latest version of the ape server, and then refer to the installation manual. After a few steps, you can start creating your own real-time web application!

Note: The first option is recommended (since Apache is no longer used to proxy data ).

 

And what about JavaScript?

Now your brand new ape server is perfectly working, you may need to deal with the front end! But, how do I communicate with the ape server, you may ask?

As for that, we build a lightweight JavaScript framework, that enables you to deal with all the server actions, send data to it, and real-time display those data in your rich Internet application.

The JSF, is composed of a core and Plugins. The core is based on mootools, but however plugins can be written with the use of the framework of your choice! (Jquery, dojo ...)

You do not need to care about the scary "xml http requests" and "How do I receive the data", the ape JSF handles everything! It's now time to write your first plugin, and build your own real time application!

What about JavaScript?

Now that your new ape server is working perfectly, you need to handle the front-end and back-end problems! However, you may ask: how can I communicate through the ape server?

To solve this problem, we have built a lightweight JavaScript framework that allows you to process all server actions, send data, and display the data in real time in your rich Internet applications.

This JSF is composed of a kernel and some plug-ins. The kernel is based on mootools, but the plug-in can be written using any framework you like! (Jquery, dojo ...)

You don't have to worry about issues such as "xml http requests" and "How can I receive data". Ape JSF will handle everything! It's time to write your first plug-in and create the first real-time application!

 

The ape Protocol

The ape protocol is the gateway of the communication between the ape server and the ape JavaScript framework. The Basics of the protocol works with raw and commands.

Ape Protocol

The ape protocol is a level between the ape server and the ape JavaScript framework. The protocol is based on raw and commands.

 

Commands

The ape server is controllable via commands sent by an external client (For exemple the ape JavaScript framework. The commands are sent via an HTTP request to the server via GET or post methods.

Commands

The ape server controls the commands sent from the extended client (such as the ape JavaScript framework. Commands sends an HTTP request through the get or POST method.

 

Raw

The answers of the server are called raw and are sent as a JSON object. Here is a non exhaustive list of raws:

Received message, login, error, libape-controller data...

Raw

The server response is called raw and sent as a JSON object. Here is a simple list of raws:

Receive information, log on, error, control data...

 

Let's get started: first ape tutorial

Now you're familiar with the global working of the ape JSF, you shocould try to develop your first ape application while following our first tutorial.

Get started: ape getting started

Now you are familiar with the global work of ape JSF. You can use our getting started tutorial to develop your first ape application.