mobi/seedvault
1
0
Fork 0
Code Pull requests Activity

Add missing docs for sendBackupData()

Browse source
This commit is contained in:
Torsten Grote 2024-06-27 17:19:12 -03:00
parent 7afd496db9
commit 490c7882e4
No known key found for this signature in database
GPG key ID: 3E5F77D92CF891FF
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
app/src/main/java/com/stevesoltys/seedvault/transport/backup/BackupCoordinator.kt
View file

@ -277,6 +277,16 @@ internal class BackupCoordinator(
return full.performFullBackup(targetPackage, fileDescriptor, flags, token, salt) return full.performFullBackup(targetPackage, fileDescriptor, flags, token, salt)
} }
/**
* Tells the transport to read [numBytes] bytes of data from the socket file descriptor
* provided in the [performFullBackup] call, and deliver those bytes to the datastore.
*
* @param numBytes The number of bytes of tarball data available to be read from the socket.
* @return [TRANSPORT_OK] on successful processing of the data; [TRANSPORT_ERROR] to
* indicate a fatal error situation. If an error is returned, the system will
* call finishBackup() and stop attempting backups until after a backoff and retry
* interval.
*/
suspend fun sendBackupData(numBytes: Int) = full.sendBackupData(numBytes) suspend fun sendBackupData(numBytes: Int) = full.sendBackupData(numBytes)
/** /**