https://github.com/bbqsrc/bbqws
A minimalist websocket wrapper.
https://github.com/bbqsrc/bbqws
Last synced: 12 months ago
JSON representation
A minimalist websocket wrapper.
- Host: GitHub
- URL: https://github.com/bbqsrc/bbqws
- Owner: bbqsrc
- Created: 2012-10-13T07:11:44.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-10-14T08:24:57.000Z (over 13 years ago)
- Last Synced: 2024-12-31T21:12:02.382Z (about 1 year ago)
- Language: Python
- Size: 121 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bbqws
A minimalist websocket wrapper.
## Client usage
### CoffeeScript
```coffeescript
ws = new bbqws("localhost:8888")
ws.on "connect", ->
console.log "Connected!"
ws.on "example", (data) ->
# Do something with response
ws.connect()
ws.emit "example", data: "all kinds of data"
ws.emit "example", [1, 2, 3]
ws.emit "example", true
ws.emit "example"
```
### JavaScript
```javascript
var ws = new bbqws("localhost:8888");
ws.on("connect", function() {
console.log("Connected!");
});
ws.on("example", function(data) {
// Do something with response
});
ws.connect();
ws.emit("example", {data: "all kinds of data"});
ws.emit("example", [1, 2, 3]);
ws.emit("example", true);
ws.emit("example");
```
## Server usage
This is a very basic implementation, implemented using Tornado's WebSocket handler.
```python
import tornado.web
import tornado.ioloop
import tornado.options
from bbqws import BbqwsSocket
class ExampleHandler(BbqwsSocket):
def on_example(self, message):
self.emit("response", {"msg": "hurray!"})
application = tornado.web.Application([
(r"/", ExampleHandler),
])
tornado.options.parse_command_line()
application.listen(8888)
tornado.ioloop.IOLoop.instance().start()
```