Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add doc string for __nonzero__ overrides for sync results, raise not implemented if the client attempts to do a gapless sync

This commit is contained in:
Mark Haines 2015-01-30 15:52:05 +00:00
parent 8bc3066e0b
commit 017dfaef4c
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
synapse/handlers/sync.py
View File

@ -49,6 +49,9 @@ class RoomSyncResult(collections.namedtuple("RoomSyncResult", [
__slots__ = [] __slots__ = []
def __nonzero__(self): def __nonzero__(self):
"""Make the result appear empty if there are no updates. This is used
to tell if room needs to be part of the sync result.
"""
return bool(self.events or self.state or self.ephemeral) return bool(self.events or self.state or self.ephemeral)
@ -61,6 +64,10 @@ class SyncResult(collections.namedtuple("SyncResult", [
__slots__ = [] __slots__ = []
def __nonzero__(self): def __nonzero__(self):
"""Make the result appear empty if there are no updates. This is used
to tell if the notifier needs to wait for more events when polling for
events.
"""
return bool( return bool(
self.private_user_data or self.public_user_data or self.rooms self.private_user_data or self.public_user_data or self.rooms
) )
@ -108,7 +115,7 @@ class SyncHandler(BaseHandler):
return self.incremental_sync_with_gap(sync_config, since_token) return self.incremental_sync_with_gap(sync_config, since_token)
else: else:
#TODO(mjark): Handle gapless sync #TODO(mjark): Handle gapless sync
pass raise NotImplementedError()
@defer.inlineCallbacks @defer.inlineCallbacks
def initial_sync(self, sync_config): def initial_sync(self, sync_config):