Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Tornado server-sent events
"""Demonstration of server-sent events with Tornado. To see the
stream, you can either point your browser to ``http://localhost:8080``
or use ``curl`` like so::
$ curl http://localhost:8080/events
"""
import signal
from tornado import web, gen
from tornado.options import options
from tornado.httpserver import HTTPServer
from tornado.ioloop import IOLoop, PeriodicCallback
from tornado.iostream import StreamClosedError
html = """
<div id="messages"></div>
<script type="text/javascript">
var source = new EventSource('/events');
source.onmessage = function(message) {
var div = document.getElementById("messages");
div.innerHTML = message.data + "<br>" + div.innerHTML;
};
</script>"""
def fibonacci():
a, b = 0, 1
while True:
yield a
a, b = b, a + b
class DataSource(object):
"""Generic object for producing data to feed to clients."""
def __init__(self, initial_data=None):
self._data = initial_data
@property
def data(self):
return self._data
@data.setter
def data(self, new_data):
self._data = new_data
class EventSource(web.RequestHandler):
"""Basic handler for server-sent events."""
def initialize(self, source):
"""The ``source`` parameter is a string that is updated with
new data. The :class:`EventSouce` instance will continuously
check if it is updated and publish to clients when it is.
"""
self.source = source
self._last = None
self.set_header('content-type', 'text/event-stream')
self.set_header('cache-control', 'no-cache')
@gen.coroutine
def publish(self, data):
"""Pushes data to a listener."""
try:
self.write('data: {}\n\n'.format(data))
yield self.flush()
except StreamClosedError:
pass
@gen.coroutine
def get(self):
while True:
if self.source.data != self._last:
yield self.publish(self.source.data)
self._last = self.source.data
else:
yield gen.sleep(0.005)
class MainHandler(web.RequestHandler):
def get(self):
self.write(html)
if __name__ == "__main__":
options.parse_command_line()
generator = fibonacci()
publisher = DataSource(next(generator))
def get_next():
publisher.data = next(generator)
print(publisher.data)
checker = PeriodicCallback(lambda: get_next(), 1000.)
checker.start()
app = web.Application(
[
(r'/', MainHandler),
(r'/events', EventSource, dict(source=publisher))
],
debug=True
)
server = HTTPServer(app)
server.listen(8080)
signal.signal(signal.SIGINT, lambda x, y: IOLoop.instance().stop())
IOLoop.instance().start()
@Prabhusarathy18
Copy link

Prabhusarathy18 commented Apr 10, 2020

BTW why you were using , "\n" in
self.write('data:` {}\n\n'.format(data))

Thanks

@mivade
Copy link
Author

mivade commented Apr 10, 2020

The \n\n is how messages are delimited with SSE.

@Prabhusarathy18
Copy link

Prabhusarathy18 commented Apr 12, 2020

The \n\n is how messages are delimited with SSE.

But what if i need to print xx in one line and yy in another line.

Whenever i send strings with xx\nyy it neglects those \n

Could u help me out?

@ChouJoe
Copy link

ChouJoe commented Jun 23, 2020

hello, since EventSource def get() function include While True, i am confused with how to close the SSE connect?

@mivade
Copy link
Author

mivade commented Jun 23, 2020

This demo was assuming there's always going to be data streaming. If you have a condition where you're done sending, you can just return from the function (or raise web.Finish).

@gruentee
Copy link

gruentee commented Oct 7, 2020

Thanks for this useful demo!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment