LODDS (Local Open Distributed Data Sharing)

LODDS is a decentral (local) network file-sharing protocol. This Repository contains the Protocol and its Implementations.

• Protocol
• Java Implementation
• Common Lisp Implementation

TODO

• Advertised name Specification (whitespace allowed?)
• Regex for relative Filename (/, , :, *, ?, ", <, >, |, %)

Mid Lvl API

set-available-interfaces():List<String>interfaces
get-broadcast-adress(String interface): Broadcast-Adress
get-ip-adress(String interface): IP-Adress
watch-directory(dir, Obj): __dead
getFile(checksum)
getFiles(List<FileInfo>, User)
getFile(FileInfo, maxConncetions)
getFiles(List<FileInfo>, maxConncetions)
getLoads(checksum):List<user-loads>

Lodds-Object

startAdvertising()
stopAdvertising()
startListening()
stopListening()
getUsers()
setInterface()
getInterface()
setAdvertisePort()
getAdvertisePort()
setListenPort()
getListenPort()
setUserName(String Name)
getFile(String user, String checksum, String localPath)
getUserConncectionInfo(user): UserInfo[IP, Port]
shareFolder(path): int
unshareFolder(path)
getSharedFolders():List<String>
getOutstandingBytes():List<IP, Name, File, Bytes>
getFileChanges(Timestamp)

Lists'n'Stuff

• filechanges(Timestamp, name, checksum, size)
• clients(ip, port, name, timestamp, load, fileList, lastUpd)
• currentOutstandingBytes(current active transfers)
• outstanding send permissions you should accept
• all available files

Commit Message Format

For our commit messages, we use a precise format. This should include a headline before information about specific changes. You can read more about it here. We also tag our commit message headlines to distinguish between certain commits. For example every change to the common lisp code is tagged with a lisp tag, java code is tagged with java etc.

Commit Tags and Format

Format

Headlines begin with a tag. Tags end with a :, multiple tags can be combined (concatenated with space in between). For example:

lisp: doc: updated function documentation

...

List of Tags

tag	description
java	commit concerning java code
lisp	commit concerning lisp code
doc	documentation change (no code changed)
spec	specification change
bugfix	a bug was fixed!
style	code style changes (no code changed)
layout	code layout changes (no code change)
readme	README was updated