Document case of unconnected chunks

This commit is contained in:
Erik Johnston 2018-05-17 16:07:20 +01:00
parent a638649254
commit 12fd6d7688
1 changed files with 4 additions and 0 deletions

View File

@ -38,6 +38,10 @@ class ChunkDBOrderedListStore(OrderedListStore):
second chunk, then we say that the first chunk references the second, and
thus forming a DAG.
The server may only have a subset of all events in a room, in which case
its possible for the server to have chunks that are unconnected from each
other. The ordering between unconnected chunks is arbitrary.
The class is designed for use inside transactions and so takes a
transaction object in the constructor. This means that it needs to be
re-instantiated in each transaction, so all state needs to be stored