summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSandro Knauß <mail@sandroknauss.de>2014-05-29 17:31:11 (GMT)
committerSandro Knauß <mail@sandroknauss.de>2014-05-29 17:35:21 (GMT)
commit1a7f746a31c0aae39d913283426e0e381d8fc750 (patch)
tree1c47c558edb4b22322376a4b4ea323f573a1f20f
parent33dcb7e0cf218c500eb30e2421a26a69ef19df15 (diff)
downloadkolab-utils-1a7f746a31c0aae39d913283426e0e381d8fc750.tar.gz
Added description for daemon mode
-rw-r--r--fbdaemon/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/fbdaemon/README b/fbdaemon/README
index 9bc3bf9..eeb2193 100644
--- a/fbdaemon/README
+++ b/fbdaemon/README
@@ -31,6 +31,42 @@ The aggregator reads all freebusy objects, merges the periods of each object and
The default output directory is /var/lib/kolab-freebusy
+== Daemon mode ==
+
+A daemon that clients can use to generate F/B-Information for users and folders. The daemon starts an AF_INET socket for incoming connections.
+
+The protocol is similar to IMAP but untagged since no parallel requests are supported.
+
+Generate F/B for a user for the period between timestamp1 and timestamp2 which are unix timestamps:
+
+ C: IFB USER "$email" slot:$timestamp1-$timestamp2
+ S: * ({$datasize}\r\n$ifbdata)
+ S: OK
+
+The timestamps are optional, and $now:$now+$defaultvalue are used, if not available.
+
+Generate F/B for a folder for the period between timestamp1 and timestamp2 which are unix timestamps:
+
+ C: IFB FOLDER "$path" slot:$timestamp1-$timestamp2
+ S: * ({$datasize}\r\n$ifbdata)
+ S: OK
+
+The timestamps are optional, and $now:$now+$defaultvalue shall be used if not available.
+
+'interval' is a default nominator for a default interval, i.e.:
+
+ C: IFB EMAIL "$email" slot:interval-1402593346
+
+shall depict F/B $default_interval counting backwards from 1402593346, and
+
+ C: IFB EMAIL "$email" slot:1402593346-interval
+
+shall depict F/B $default_interval counting forwards from 1402593346.
+
+If there is an error:
+
+ S:BAD $reason
+
== Configuration ==
The configruation file is by default at /etc/kolab/kolab.conf. The location can be overridden using --configuration.