Skip to main content

Real time communication for pyramid using WebSockets

Project description

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



Changelog
=========

0.4
---

- Add support for the HyBi version of WebSockets (specifically version-10). This version was released to solve some previous security concerns and
will be the version in Firefox 7/8 and Chrome 14 onwards accoring to Wikipedia.
- Introduces a dependency on ws4py

- See http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10

0.3
---

- Fix bug in setup.py
- Improve documentation and consistency with pyramid naming

0.2
---

- Support for version 76 of the websocket handshake

0.1
---

- Initial release, ported from rpz.websocket and repoze.bfg to pyramid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stargate-0.4.tar.gz (418.9 kB view details)

Uploaded Source

File details

Details for the file stargate-0.4.tar.gz.

File metadata

  • Download URL: stargate-0.4.tar.gz
  • Upload date:
  • Size: 418.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for stargate-0.4.tar.gz
Algorithm Hash digest
SHA256 4093135dbc02ba45b10e88787e8ce35e1e5765b38c3479e0421804383323e82e
MD5 04cd1a369ced91f104eb7abc7ad5bd86
BLAKE2b-256 46f7e361e8a3aa76c362cc6e6ac965ab46dd73c9b16f2b1991ca85604fe054c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page