Permalink
Browse files

Queued updates

  • Loading branch information...
1 parent 9679096 commit 622f4539576084cfa151478e76edd0a328d35359 @rwaldron committed May 23, 2011
Showing with 487 additions and 487 deletions.
  1. +165 −165 README.markdown
  2. +73 −73 example.js
  3. +249 −249 jquery.eventsource.js
View
@@ -1,165 +1,165 @@
-# jQuery.EventSource
-
-
-Gives developers the power of the EventSource API across browsers. Uses the EventSource constructor when natively available
-and falls back to Ajax polling logic when it's not.
-
-
-[http://wiki.github.com/rwldrn/jquery.eventsource/](http://wiki.github.com/rwldrn/jquery.eventsource/)
-
-
-[http://code.bocoup.com/jquery.eventsource/unit-tests/](http://code.bocoup.com/jquery.eventsource/unit-tests/)
-
-
-## Some Thoughts...
-
-* Q. why use EventSource rather than Websockets?<br>
- A. EventSource is easier to setup on server (uses http), lighter and most of the times - that's what you acually need. (via temp01)
-
-
-## Real World Example
-
-[http://yakyakface.com/](http://yakyakface.com/)
-
-
-## Provides cross browser implementation for:
-
-[http://dev.w3.org/html5/eventsource/](http://dev.w3.org/html5/eventsource/)
-
-
-## Unit tests
-
-[http://yakyakface.com/jquery.eventsource/unit-tests/](http://yakyakface.com/jquery.eventsource/unit-tests/)
-
-
-
-
-## Usage
-
- $.eventsource({
-
- // Assign a label to this event source
-
- label: 'event-source-label',
-
- // Set the file to receive data from the server
-
- url: 'event-sources/server-event-source.php',
-
- // Set the type of data you expect to be returned
- // text, json supported
-
- dataType: 'json',
-
- // Set a callback to fire when the event source is opened
- // `onopen`
- open: function (data) {
-
-
- console.log(data);
-
- },
-
- // Set a callback to fire when a message is received
- // `onmessage`
- message: function (data) {
-
-
- console.log(data);
-
- }
- });
-
-
- // Close event sources by label name
-
- $.eventsource('close', 'event-source-label');
-
-
-## Varied Content Type Usage
-
-
- // PLAIN TEXT EXAMPLE - NO CONTENT TYPE GIVEN
- $.eventsource({
- label: 'text-event-source',
- url: 'test-event-sources/text-event-source.php',
- open: function () {
-
- console.log( 'opened' );
-
- },
- message: function (data) {
-
- console.log(data);
-
-
- $.eventsource('close', 'text-event-source');
- }
- });
-
- // PLAIN TEXT EXAMPLE - HAS CONTENT TYPE
- $.eventsource({
- label: 'text-event-source-ct',
- url: 'test-event-sources/text-event-source-ct.php',
- dataType: 'text',
-
- message: function (data) {
-
- console.log(data);
-
- $.eventsource('close', 'text-event-source-ct');
- }
- });
-
-
- // JSON EXAMPLE - HAS CONTENT TYPE
- $.eventsource({
- label: 'json-event-source',
- url: 'test-event-sources/json-event-source.php',
- dataType: 'json',
- open: function () {
-
- console.log( 'opened' );
-
- },
- message: function (data) {
-
- console.log(data);
-
- $.eventsource('close', 'json-event-source');
- }
- });
-
-
-## Accessing your current event sources:
-
- // Returns an object containing all the currently active eventsource streams
- $.eventsource('streams')
-
-
-## Server Source Requirements
-
- // Server response MUST be Content-Type: text/event-stream
- // Server response MUST be prepended with 'data: '
-
-
- // Examples:
-
- // PHP
- header("Content-Type: text/event-stream\n\n");
- echo 'data: this is a valid response';
-
-
- // Python
- print "Content-Type: text/event-stream"
- print "data: this is a valid response"
-
-
-
-
-
-
-
-
-
-
+# jQuery.EventSource
+
+
+Gives developers the power of the EventSource API across browsers. Uses the EventSource constructor when natively available
+and falls back to Ajax polling logic when it's not.
+
+
+[http://wiki.github.com/rwldrn/jquery.eventsource/](http://wiki.github.com/rwldrn/jquery.eventsource/)
+
+
+[http://code.bocoup.com/jquery.eventsource/unit-tests/](http://code.bocoup.com/jquery.eventsource/unit-tests/)
+
+
+## Some Thoughts...
+
+* Q. why use EventSource rather than Websockets?<br>
+ A. EventSource is easier to setup on server (uses http), lighter and most of the times - that's what you acually need. (via temp01)
+
+
+## Real World Example
+
+[http://yakyakface.com/](http://yakyakface.com/)
+
+
+## Provides cross browser implementation for:
+
+[http://dev.w3.org/html5/eventsource/](http://dev.w3.org/html5/eventsource/)
+
+
+## Unit tests
+
+[http://yakyakface.com/jquery.eventsource/unit-tests/](http://yakyakface.com/jquery.eventsource/unit-tests/)
+
+
+
+
+## Usage
+
+ $.eventsource({
+
+ // Assign a label to this event source
+
+ label: 'event-source-label',
+
+ // Set the file to receive data from the server
+
+ url: 'event-sources/server-event-source.php',
+
+ // Set the type of data you expect to be returned
+ // text, json supported
+
+ dataType: 'json',
+
+ // Set a callback to fire when the event source is opened
+ // `onopen`
+ open: function (data) {
+
+
+ console.log(data);
+
+ },
+
+ // Set a callback to fire when a message is received
+ // `onmessage`
+ message: function (data) {
+
+
+ console.log(data);
+
+ }
+ });
+
+
+ // Close event sources by label name
+
+ $.eventsource('close', 'event-source-label');
+
+
+## Varied Content Type Usage
+
+
+ // PLAIN TEXT EXAMPLE - NO CONTENT TYPE GIVEN
+ $.eventsource({
+ label: 'text-event-source',
+ url: 'test-event-sources/text-event-source.php',
+ open: function () {
+
+ console.log( 'opened' );
+
+ },
+ message: function (data) {
+
+ console.log(data);
+
+
+ $.eventsource('close', 'text-event-source');
+ }
+ });
+
+ // PLAIN TEXT EXAMPLE - HAS CONTENT TYPE
+ $.eventsource({
+ label: 'text-event-source-ct',
+ url: 'test-event-sources/text-event-source-ct.php',
+ dataType: 'text',
+
+ message: function (data) {
+
+ console.log(data);
+
+ $.eventsource('close', 'text-event-source-ct');
+ }
+ });
+
+
+ // JSON EXAMPLE - HAS CONTENT TYPE
+ $.eventsource({
+ label: 'json-event-source',
+ url: 'test-event-sources/json-event-source.php',
+ dataType: 'json',
+ open: function () {
+
+ console.log( 'opened' );
+
+ },
+ message: function (data) {
+
+ console.log(data);
+
+ $.eventsource('close', 'json-event-source');
+ }
+ });
+
+
+## Accessing your current event sources:
+
+ // Returns an object containing all the currently active eventsource streams
+ $.eventsource('streams')
+
+
+## Server Source Requirements
+
+ // Server response MUST be Content-Type: text/event-stream
+ // Server response MUST be prepended with 'data: '
+
+
+ // Examples:
+
+ // PHP
+ header("Content-Type: text/event-stream\n\n");
+ echo 'data: this is a valid response';
+
+
+ // Python
+ print "Content-Type: text/event-stream"
+ print "data: this is a valid response"
+
+
+
+
+
+
+
+
+
+
Oops, something went wrong.

0 comments on commit 622f453

Please sign in to comment.