https://github.com/h2non/sencha-websocket
WebSocket client abstraction library for Sencha JavaScript frameworks (DEPRECATED)
https://github.com/h2non/sencha-websocket
Last synced: 8 months ago
JSON representation
WebSocket client abstraction library for Sencha JavaScript frameworks (DEPRECATED)
- Host: GitHub
- URL: https://github.com/h2non/sencha-websocket
- Owner: h2non
- License: other
- Created: 2012-10-01T13:35:57.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2013-01-03T21:29:37.000Z (almost 13 years ago)
- Last Synced: 2024-10-18T11:25:56.648Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.83 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sencha WebSocket
Sencha WebSocket is a WebSocket library for Sencha JavaScript frameworks.
It provides a lot of functionalities, extensible event-handling, full integration with Sencha core framework, abstraction from JavaScript native API and more...
## What is WebSocket?
WebSocket is a web technology providing for bi-directional, full-duplex communications channels over a single TCP connection.
WebSocket is designed to be implemented in web browsers and web servers, but it can be used by any client or server application.
The WebSocket protocol is an independent TCP-based protocol. Its only relationship to HTTP is that its handshake is interpreted by HTTP servers as an Upgrade request.
The WebSocket protocol makes possible more interaction between a browser and a web site, facilitating live content and the creation of real-time applications.
More information:
## Features
- Abstraction from native JavaScript API
- Full integration with the Sencha core framework (see frameworks supported)
- Complete and extensible event-handling support
- General improves for better WebSocket API management
- Support for custom JSON-based packets
- Error handling
- Standard error messages
- Debugging
- Easy-to-use
- Well documented
### TODO
- Buffer and JSON-based packets support
- Limits/performance
- Strong error handling
- Support third-party application-level WebSocket-based protocols (such as WebSocket Application Messaging Protocol)
- Real apps examples
### WebSocket JavaScript API specification
The current implementation is based on the W3C JavaScript API specification (dated 09.20.2012).
Note WebSocket protocol is under continuous development and improvement, so that means is still experimental.
See
See
The WebSocket procotol is standarized the IETF. See
### Sencha frameworks support
- ExtJS 4.0.x
- ExtJS 4.1.x
- Sencha Touch 2.0.x
- Sencha Touch 2.1.x
In other words, is supported all Ext Core 4.x based-frameworks
## Browser support (RFC 6455 specification)
- Mozilla Firefox >= 11 | >= 6
- Google Chrome >= 16
- Opera >= 12.50
- Safari >= 6
- Internet Explorer >= 10
For more info about browsers support see
## WebSocket servers
A list of some WebSocket servers
- Node.js
- Socket.IO Server
- WebSocket.IO
- ws
- WebSocket-Node
- SockJS-Node
- Python
- Sock-JS Tornado
- pywebsocket
- PHP
- Ratchet
- php-websocket
- PHP WebSocket
- Ruby
- em-websocket
- web-socket-ruby
- Cramp
- Erlang
- erws
- sockjs-erlang
- Java
- jWebSocket
- C++
- WebSocket++
- Standalone
- Netty
## Examples
### Basic WebSocket client example
```html
Sencha WebSocket Examples - Basic
Ext.onReady(function () {
// local socket example
var socket = Ext.ux.websocket.WebSocket.create({
url: 'ws://localhost:8080/', //'ws://localhost:8080/socket.io/1/websocket/',
listeners: {
open: function () {
console.log('The socket is open!');
socket.send({ sample: 'This is a sample data string' });
},
message: function (event) {
document.write('Data received -> ' + event.getData() + '<br>');
},
close: function (event) {
console.log('Socket closed: ' + event.getCode() + ' -> ' + event.getReason());
}
}
});
});
Sencha WebSocket library example
```
### Socket.IO example
```html
Sencha WebSocket Examples - Socket.IO
Ext.onReady(function () {
// local socket example
var socket = Ext.ux.websocket.WebSocket.create({
server: 'socket.io',
url: 'http://localhost:8080/',
debug: true,
emitters: {
news: function (data) {
document.write('News -> ' + data + '<br>');
},
message: function (data) {
document.write('Message -> ' + data + '<br>');
}
},
listeners: {
connect: function () {
console.log('Socket.IO is connected');
setInterval(function (me) {
me.send({ sample: 'This is a sample data string' });
}, 3000, this);
},
message: function (event, message, data) {
console.log('Message event: ' + message.getData());
},
close: function (event) {
console.log('Socket closed: ' + event.getCode() + ' -> ' + event.getReason());
}
}
});
});
Sencha WebSocket library example
```
## Documentation
Take a look at the latest library API documentation:
## Changelog
- `0.1.1 beta` First release, not completed yet, work in progress.
## Author
- Tomas Aparicio
## Issues
Feel free to report any issue you experiment via Github
Any [feedback](mailto:tomas@rijndael-project.com) is also welcome :)
## License
(C) 2012 Tomas Aparicio
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .