source: box/trunk/docs/api-notes/lib_backupclient.txt @ 2478

Revision 2478, 1.1 KB checked in by chris, 3 years ago (diff)

Rearrangement of api-notes directory.

  • Property svn:eol-style set to native
Line 
1TITLE lib/backupclient
2
3Classes used on the store and on the server.
4
5See documentation in the files for more details.
6
7
8SUBTITLE BackupStoreDirectory
9
10The directory listing class, containing a number of entries, representing files.
11
12
13SUBTITLE BackupStoreFile
14
15Handles compressing and encrypting files, and decoding files downloaded from the server.
16
17
18SUBTITLE BackupStoreFilename
19
20An encrypted filename.
21
22
23SUBTITLE BackupStoreFilenameClear
24
25Derived from BackupStoreFilename, but with the ability to encrypt and decrypt filenames. Client side only.
26
27
28SUBTITLE BackupClientFileAttributes
29
30Only used on the client -- the server treats attributes as blocks of opaque data.
31
32This reads attributes from files on discs, stores them, encrypts them, and applies them to new files.
33
34Also has a static function to generate filename attribute hashes given a struct stat and the filename.
35
36
37SUBTITLE BackupClientRestore
38
39Routines to restore files from the server onto the client filesystem.
40
41
42SUBTITLE BackupClientCryptoKeys
43
44This reads the key material from disc, and sets up the crypto for storing files, attributes and directories.
45
46
Note: See TracBrowser for help on using the repository browser.