2021-05-16 20:48:34 +00:00
|
|
|
import queue
|
|
|
|
|
import sse
|
2021-05-18 10:17:02 +00:00
|
|
|
import json
|
2021-05-16 20:48:34 +00:00
|
|
|
from exceptions import TooManyConnections
|
|
|
|
|
|
2021-05-18 10:17:02 +00:00
|
|
|
class Sse(object):
|
|
|
|
|
def __init__(self, default_retry=2000):
|
|
|
|
|
self._buffer = []
|
|
|
|
|
self.set_retry(default_retry)
|
|
|
|
|
|
|
|
|
|
def set_retry(self, num):
|
|
|
|
|
"""
|
|
|
|
|
Set distinct retry timeout instead the default
|
|
|
|
|
value.
|
|
|
|
|
"""
|
|
|
|
|
self._retry = num
|
|
|
|
|
self._buffer.append("retry: {0}\n".format(self._retry))
|
|
|
|
|
|
|
|
|
|
def set_event_id(self, event_id):
|
|
|
|
|
if event_id:
|
|
|
|
|
self._buffer.append("id: {0}\n".format(event_id))
|
|
|
|
|
else:
|
|
|
|
|
# Reset event id
|
|
|
|
|
self._buffer.append("id\n")
|
|
|
|
|
|
|
|
|
|
def reset_event_id(self):
|
|
|
|
|
"""
|
|
|
|
|
Send a reset event id.
|
|
|
|
|
"""
|
|
|
|
|
self.set_event_id(None)
|
|
|
|
|
|
|
|
|
|
def _parse_text(self, text, encoding):
|
|
|
|
|
# parse text if is list, tuple or set instance
|
|
|
|
|
if isinstance(text, (list, tuple, set)):
|
|
|
|
|
for item in text:
|
|
|
|
|
if isinstance(item, bytes):
|
|
|
|
|
item = item.decode(encoding)
|
|
|
|
|
|
|
|
|
|
for subitem in item.splitlines():
|
|
|
|
|
yield subitem
|
|
|
|
|
|
|
|
|
|
else:
|
|
|
|
|
if isinstance(text, bytes):
|
|
|
|
|
text = text.decode(encoding)
|
|
|
|
|
|
|
|
|
|
for item in text.splitlines():
|
|
|
|
|
yield item
|
|
|
|
|
|
|
|
|
|
def add_message(self, event, text, encoding='utf-8'):
|
|
|
|
|
"""
|
|
|
|
|
Add messaget with eventname to the buffer.
|
|
|
|
|
|
|
|
|
|
:param str event: event name
|
|
|
|
|
:param str/list text: event content. Must be a str or list of str
|
|
|
|
|
:param bool split: splits str content by lines. default(true)
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
self._buffer.append("event: {0}\n".format(event))
|
|
|
|
|
|
|
|
|
|
for text_item in self._parse_text(text, encoding):
|
|
|
|
|
self._buffer.append("data: {0}\n".format(text_item))
|
|
|
|
|
|
|
|
|
|
self._buffer.append("\n")
|
|
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
|
return self.__unicode__()
|
|
|
|
|
|
|
|
|
|
def __unicode__(self):
|
|
|
|
|
return "".join(self._buffer)
|
|
|
|
|
|
|
|
|
|
def flush(self):
|
|
|
|
|
"""
|
|
|
|
|
Reset the internal buffer to initial state.
|
|
|
|
|
"""
|
|
|
|
|
self._buffer = []
|
|
|
|
|
|
|
|
|
|
def __iter__(self):
|
|
|
|
|
return self
|
|
|
|
|
|
|
|
|
|
def __next__(self):
|
|
|
|
|
print("Next in SSE")
|
|
|
|
|
print(self._buffer)
|
|
|
|
|
for item in self._buffer:
|
|
|
|
|
return item
|
|
|
|
|
self.flush()
|
|
|
|
|
|
|
|
|
|
|
2021-05-16 20:48:34 +00:00
|
|
|
class SseStream():
|
|
|
|
|
__queues = {}
|
|
|
|
|
__maxConnections = 10
|
|
|
|
|
__queue_size = 50
|
|
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
|
def setMaxConnections(maxConnections = 10):
|
|
|
|
|
""" Set maximum number of concurrent connections
|
|
|
|
|
---
|
|
|
|
|
Paremeters:
|
|
|
|
|
------
|
|
|
|
|
maxConnections: int, optional
|
|
|
|
|
The number of maximum concurrent connections ( default value is 10) """
|
|
|
|
|
SseStream.__maxConnections = maxConnections
|
|
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
|
def setQueueSize(queueSize = 50):
|
|
|
|
|
""" Set the queue size for stored messages
|
|
|
|
|
---
|
|
|
|
|
Parementers
|
|
|
|
|
------
|
|
|
|
|
queueSize: int, optional
|
|
|
|
|
The number of stored messages in the queue, set to <=0 for unlimited size ( default value is 50 ) """
|
|
|
|
|
SseStream.__queue_size = queueSize
|
|
|
|
|
|
|
|
|
|
def __init__(self, id):
|
|
|
|
|
""" Init a new stream
|
|
|
|
|
---
|
|
|
|
|
Paremeters:
|
|
|
|
|
------
|
|
|
|
|
id: string
|
|
|
|
|
The unique id of the client
|
|
|
|
|
"""
|
|
|
|
|
if len( self.__queues ) >= self.__maxConnections:
|
|
|
|
|
raise TooManyConnections
|
|
|
|
|
|
|
|
|
|
if not self.__queues.get( id ):
|
|
|
|
|
self._queue = queue.Queue( self.__queue_size )
|
|
|
|
|
self.__queues[ id ] = self._queue
|
|
|
|
|
|
|
|
|
|
print(f"Queue size: {self.__queue_size}; Connections: { len( self.__queues ) }/{self.__maxConnections}; ID: {id}")
|
|
|
|
|
|
|
|
|
|
def __del__(self):
|
|
|
|
|
""" Deregister client from queue - clean up """
|
|
|
|
|
print( "Stream object is deleted")
|
|
|
|
|
|
|
|
|
|
def __iter__(self):
|
2021-05-18 10:17:02 +00:00
|
|
|
print("Iter called")
|
2021-05-16 20:48:34 +00:00
|
|
|
return self
|
|
|
|
|
|
|
|
|
|
def __next__(self):
|
|
|
|
|
""" Method which is called regular to send out the event """
|
2021-05-18 10:17:02 +00:00
|
|
|
print("Next called")
|
|
|
|
|
print(f'Queue Size: {self._queue.qsize()}')
|
2021-05-16 20:48:34 +00:00
|
|
|
while True:
|
2021-05-18 10:17:02 +00:00
|
|
|
msg = self._queue.get(block=True, timeout=None)
|
|
|
|
|
if isinstance( msg, Sse ):
|
2021-05-16 20:48:34 +00:00
|
|
|
for data in msg:
|
2021-05-18 10:17:02 +00:00
|
|
|
print(data)
|
|
|
|
|
return data.encode('utf-8')
|
2021-05-16 20:48:34 +00:00
|
|
|
|
2021-05-16 21:17:07 +00:00
|
|
|
def addMessage(self, event_name, data, id = 0):
|
|
|
|
|
"""
|
|
|
|
|
Adds a event to the queue so it can be sent out
|
|
|
|
|
---
|
|
|
|
|
Parameters:
|
|
|
|
|
------
|
|
|
|
|
event_name: str
|
|
|
|
|
Name of the event
|
|
|
|
|
data: string or list of strings
|
|
|
|
|
Datat to be send
|
|
|
|
|
id: int
|
|
|
|
|
id of the event, if set to 0 no ID will be sent """
|
2021-05-18 10:17:02 +00:00
|
|
|
event = Sse()
|
|
|
|
|
# if id > 0:
|
|
|
|
|
# event.set_event_id(id)
|
|
|
|
|
# else:
|
|
|
|
|
# event.reset_event_id()
|
2021-05-16 21:17:07 +00:00
|
|
|
event.add_message( event_name, data )
|
2021-05-18 10:17:02 +00:00
|
|
|
self._queue.put( event )
|
2021-05-16 21:17:07 +00:00
|
|
|
|
|
|
|
|
|
2021-05-16 20:48:34 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def main():
|
|
|
|
|
SseStream.setMaxConnections(5)
|
2021-05-18 10:17:02 +00:00
|
|
|
SseStream.setQueueSize(25)
|
|
|
|
|
print("Main...")
|
|
|
|
|
teststream = SseStream("Test")
|
|
|
|
|
|
|
|
|
|
for i in range(1, 10):
|
|
|
|
|
teststream.addMessage( "test", f'Message Nr: {i}', i )
|
|
|
|
|
|
|
|
|
|
from flask import Flask, current_app, Blueprint
|
|
|
|
|
|
|
|
|
|
sse = Blueprint('sse', __name__)
|
|
|
|
|
|
|
|
|
|
@sse.route('')
|
|
|
|
|
def stream():
|
|
|
|
|
return current_app.response_class( teststream, mimetype='text/event-stream' )
|
|
|
|
|
|
|
|
|
|
app = Flask(__name__)
|
|
|
|
|
app.debug = True
|
|
|
|
|
app.register_blueprint(sse, url_prefix='/stream')
|
|
|
|
|
app.run()
|
|
|
|
|
|
2021-05-16 20:48:34 +00:00
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
|
main()
|