Legion

Legion lets you easily create or extend web applications with peer-to-peer interactions!

Legion offers:

With peer-to-peer enabled, your get lower client-to-client latency, reduced server load and disconnected operation!1

The code to run your own is available on github: https://github.com/albertlinde/Legion

Legion is under continuous development and not production-stable. Work in progress:

Legion is a result from the European project Syncfree. The Legion development team combines researchers from the Informatics Department, FCT, NOVA University of Lisbon and the NOVA LINCS Laboratory in Portugal and researchers from the Technische Universit├Ąt Kaiserslautern in Germany.

Part of the computing resources used for this work were supported by an AWS in Education Research Grant.

Syncfree project FCT, UNL NOVA LINCS Technische Universitat Kaiserslautern LightKoneEU

The following code shows how the Legion framework can be used at the client.

    var options = {
        client_id: randInt(), client_secret: randInt() //ex: username, pwd
    };
    var legion = new Legion(options);                  //New Legion instance.
    var groupOptions = {
        id: "default", secret: "default"               //ex: chat rooms with login keys
    };
    legion.joinGroup(groupOptions, function (group) {  //joins a group of peers
        var objectStore = group.getObjectStore();      //object manipulation
        var messageAPI = group.getMessageAPI();        //message sending
        (...)
    });

Counter

Counters are used to share an integer value between users. Counters can be incremented and decremented by any value.

    var counter = objectStore.getOrCreate("counterID", legion.Counter);
    counter.increment(1);                         //Argument must be >= 1
    counter.decrement(1);                         //Argument must be >= 1
    counter.increment(138);                       //Argument must be >= 1
    counter.decrement(138);                       //Argument must be >= 1
    console.log(counter.getValue());              //Returns the current value.
    counter.setOnStateChange(function (updates, meta) {//called when data is updated
        console.log(updates);
        console.log(meta);
    });
Counter Add(1) Remove(1) Value
1
2
3

Set

Sets keep objects only once.

    var set = objectStore.getOrCreate("setID", legion.Set);

    set.add(element);                   //Ads if not existing.
    set.remove(element);                //Removes if exists.

    console.log(set.asArray());         //Array of elements
    console.log(set.contains(element)); //Boolean
    console.log(set.size());            //Number
    set.setOnStateChange(function (updates, meta) {//called when data is updated
        console.log(updates);
        console.log(meta);
    });
element:
Set Add(element) Remove(element) Elements
1
2
3

Set 1 Elements

Set 2 Elements

Set 3 Elements

Map

Maps keep key-value pairs.

    var map = objectStore.get("mapID", legion.Map);

    map.set(key, value);                 //Adds a key-value pair
    map.get(key);                        //Returns value for given key.
    map.delete(key);                     //Deletes the key-value pair.

    console.log(map.asArray());          //Array of pairs
    console.log(map.keys());             //Array
    console.log(map.values());           //Array
    console.log(map.contains(element));  //Boolean
    console.log(map.size());             //Number
    map.setOnStateChange(function (updates, meta) {//called when data is updated
        console.log(updates);
        console.log(meta);
    });
key: value:
Map Set(key, value) Delete(key) # Keys
1
2
3

Map 1 Elements

Map 2 Elements

Map 3 Elements

List

Lists keep a ordered list of elements.

    var list = objectStore.get("listID", legion.List);

    list.add(pos, element);        //Adds an element to given position
    list.delete(pos);              //Removes current element at given position
    list.get(pos)                  //Returns  the element at given position

    console.log(list.asArray());   //Array of elements
    console.log(list.size());      //Number
    list.setOnStateChange(function (updates, meta) {//called when data is updated
        console.log(updates);
        console.log(meta);
    });

Input

Position: Value:
List Add(pos, value) Remove(pos) Length
List 1
List 2
List 3

List 1 Elements

List 2 Elements

List 3 Elements

    messageAPI.setHandlerFor(String, Function(arg));
    messageAPI.broadcast(String, *); //JSON.stringify(*) must parse.

    //example:
    messageAPI.setHandlerFor("Message", function(message){
        //use messsage.data
    });
    messageAPI.broadcast("Message", {value: "Hi.", from:"Albert"});

Messaging example

Name: Message: