Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 1.83 KB

README.md

File metadata and controls

41 lines (34 loc) · 1.83 KB

Portal

The Portal is a server agnostic JavaScript library that not just provides a socket for browser-based applications that need two-way communication with servers, but also aims to utilize a full duplex connection for modern web application development.

There is the Portal for Java project which is a reference implementation of the server counterpart written in Java. Look at it to implement a portal server in other languages. Sample applications are available in each server counterpart project.

The Portal and Portal for Java project is developed and maintained by Donghwan Kim. If you are interested, please subscribe to the discussion group.

How to use

Load portal.js to your application:

<script src="/portal/portal.js"></script>

Then, open a connection to the Portal server.

<script>
portal.open("/portal").on({
    // Pseudo event
    connecting: function() {},
    waiting: function(delay, attempts) {},
    // Network event
    open: function() {},
    close: function(reason) {},
    // Message event
    message: function(data) {},
    eventname: function(data) {}
});
</script>

Server

Documentation