mirror of
				https://github.com/matrix-org/synapse.git
				synced 2025-10-31 08:11:24 +01:00 
			
		
		
		
	Add some comments
This commit is contained in:
		
							parent
							
								
									84fbb80c8f
								
							
						
					
					
						commit
						26ae5178a4
					
				| @ -383,6 +383,10 @@ class KeyedEduRow(BaseFederationRow, namedtuple("KeyedEduRow", ( | |||||||
|     "key",  # tuple(str) - the edu key passed to send_edu |     "key",  # tuple(str) - the edu key passed to send_edu | ||||||
|     "edu",  # Edu |     "edu",  # Edu | ||||||
| ))): | ))): | ||||||
|  |     """Streams EDUs that have an associated key that is ued to clobber. For example, | ||||||
|  |     typing EDUs clobber based on room_id. | ||||||
|  |     """ | ||||||
|  | 
 | ||||||
|     TypeId = "k" |     TypeId = "k" | ||||||
| 
 | 
 | ||||||
|     @staticmethod |     @staticmethod | ||||||
| @ -407,6 +411,8 @@ class KeyedEduRow(BaseFederationRow, namedtuple("KeyedEduRow", ( | |||||||
| class EduRow(BaseFederationRow, namedtuple("EduRow", ( | class EduRow(BaseFederationRow, namedtuple("EduRow", ( | ||||||
|     "edu",  # Edu |     "edu",  # Edu | ||||||
| ))): | ))): | ||||||
|  |     """Streams EDUs that don't have keys. See KeyedEduRow | ||||||
|  |     """ | ||||||
|     TypeId = "e" |     TypeId = "e" | ||||||
| 
 | 
 | ||||||
|     @staticmethod |     @staticmethod | ||||||
| @ -424,6 +430,11 @@ class FailureRow(BaseFederationRow, namedtuple("FailureRow", ( | |||||||
|     "destination",  # str |     "destination",  # str | ||||||
|     "failure", |     "failure", | ||||||
| ))): | ))): | ||||||
|  |     """Streams failures to a remote server. Failures are issued when there was | ||||||
|  |     something wrong with a transaction the remote sent us, e.g. it included | ||||||
|  |     an event that was invalid. | ||||||
|  |     """ | ||||||
|  | 
 | ||||||
|     TypeId = "f" |     TypeId = "f" | ||||||
| 
 | 
 | ||||||
|     @staticmethod |     @staticmethod | ||||||
| @ -446,6 +457,10 @@ class FailureRow(BaseFederationRow, namedtuple("FailureRow", ( | |||||||
| class DeviceRow(BaseFederationRow, namedtuple("DeviceRow", ( | class DeviceRow(BaseFederationRow, namedtuple("DeviceRow", ( | ||||||
|     "destination",  # str |     "destination",  # str | ||||||
| ))): | ))): | ||||||
|  |     """Streams the fact that either a) there is pending to device messages for | ||||||
|  |     users on the remote, or b) a local users device has changed and needs to | ||||||
|  |     be sent to the remote. | ||||||
|  |     """ | ||||||
|     TypeId = "d" |     TypeId = "d" | ||||||
| 
 | 
 | ||||||
|     @staticmethod |     @staticmethod | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user