2011-05-30 Update: Tests passing 100% in Firefox/Aurora 6

TODO: Rewrite with jQuery Deferred Objects

Some Thoughts...

Real World Example

Provides cross browser implementation for:

Unit tests

Usage

$.eventsource({// Assign a label to this event sourcelabel: "event-source-label", // Set the file to receive data from the serverurl: "event-sources/server-event-source.php",// Set the type of data you expect to be returned// text, json supporteddataType: "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:// PHPheader("Content-Type: text/event-stream\n\n");echo "data: this is a valid response";// Pythonprint "Content-Type: text/event-stream"print "data: this is a valid response"