https://github.com/commandodev/stargate

WebSocket support for pyramid
https://github.com/commandodev/stargate

Last synced: 3 months ago
JSON representation

WebSocket support for pyramid

• Host: GitHub
• URL: https://github.com/commandodev/stargate
• Owner: commandodev
• Created: 2010-05-11T03:51:25.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2020-03-28T05:49:15.000Z (over 4 years ago)
• Last Synced: 2024-05-19T05:39:23.648Z (6 months ago)
• Language: Python
• Homepage:
• Size: 320 KB
• Stars: 40
• Watchers: 5
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

• awesome-pyramid - Stargate - Stargate is a package for (Async)

README

        
Introduction

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

Stargate is a package for adding WebSockets_ support to

pyramid applications using the excellent eventlet library for long running

connections

What is a WebSocket?

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

From wikipedia::

    WebSockets is a technology providing for bi-directional, full-duplex

    communications channels, over a single TCP socket

The WebSocket protocol provides a persistent low latency, low complexity way to

achieve two way communication from the browser to server.

From a client point of view using websocket is very simple::

    var ws = new WebSocket('ws://somehost/some/url');

    ws.onopen = function(msg){

        //do some cool setup

    }

    ws.onmessage = function(msg){

        //do something cool

    }

    ws.onclose = function(msg){

        //do some clean up... stay cool

    }

    // later:

    ws.send('How cool am I?!');

That's pretty much all there is to it.

Normally the websocket communication in a web app is implemented as a stand alone

server (perhaps running on a different port). rpz.websocket allows you to connect

persistent connection directly to the same objects that serve your HTML.

Documentation

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

.. note:: Still under construction

Documentation is maintained at http://boothead.github.com/stargate

References

==========

.. [WebSockets] http://en.wikipedia.org/wiki/Web_Sockets

.. [spec] http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76