summary refs log tree commit diff
path: root/synapse/storage/stream.py
diff options
context:
space:
mode:
authorErik Johnston <erikj@jki.re>2018-05-09 16:07:14 +0100
committerGitHub <noreply@github.com>2018-05-09 16:07:14 +0100
commit5adb75bcbad6646e579520b74bfc69dcc28b48ba (patch)
treec073827195a0acc6d73abc78cb279e28e0c6e820 /synapse/storage/stream.py
parentMerge pull request #3200 from matrix-org/erikj/remove_membership_change (diff)
parentFix returned token is no longer a tuple (diff)
downloadsynapse-5adb75bcbad6646e579520b74bfc69dcc28b48ba.tar.xz
Merge pull request #3198 from matrix-org/erikj/fixup_return_pagination
Refactor get_recent_events_for_room return type
Diffstat (limited to 'synapse/storage/stream.py')
-rw-r--r--synapse/storage/stream.py16
1 files changed, 15 insertions, 1 deletions
diff --git a/synapse/storage/stream.py b/synapse/storage/stream.py
index 0e313ec8f2..4f5bff973e 100644
--- a/synapse/storage/stream.py
+++ b/synapse/storage/stream.py
@@ -345,6 +345,20 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
 
     @defer.inlineCallbacks
     def get_recent_events_for_room(self, room_id, limit, end_token):
+        """Get the most recent events in the room in topological ordering.
+
+        Args:
+            room_id (str)
+            limit (int)
+            end_token (str): The stream token representing now.
+
+        Returns:
+            Deferred[tuple[list[FrozenEvent],  str]]: Returns a list of
+            events and a token pointing to the start of the returned
+            events.
+            The events returned are in ascending order.
+        """
+
         rows, token = yield self.get_recent_event_ids_for_room(
             room_id, limit, end_token,
         )
@@ -358,7 +372,7 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
 
         self._set_before_and_after(events, rows)
 
-        defer.returnValue((events, (token, end_token)))
+        defer.returnValue((events, token))
 
     @defer.inlineCallbacks
     def get_recent_event_ids_for_room(self, room_id, limit, end_token):