[CalendarServer-changes] [1687] CalendarClientSimulator/trunk/ReadMe.txt

[source_changes at macosforge.org]

Revision: 1687
          http://trac.macosforge.org/projects/calendarserver/changeset/1687
Author:   cdaboo at apple.com
Date:     2007-07-17 12:03:21 -0700 (Tue, 17 Jul 2007)

Log Message:
-----------
Add details on multisim tools.

Modified Paths:
--------------
    CalendarClientSimulator/trunk/ReadMe.txt

Modified: CalendarClientSimulator/trunk/ReadMe.txt
===================================================================
--- CalendarClientSimulator/trunk/ReadMe.txt	2007-07-17 17:23:32 UTC (rev 1686)
+++ CalendarClientSimulator/trunk/ReadMe.txt	2007-07-17 19:03:21 UTC (rev 1687)
@@ -21,7 +21,7 @@
     --server          URL for server (e.g. https://caldav.example.com:8443) [Required]
     --user            user id for user to login as [Required]
     --password        password for user [Required]
-    --interval        polling interval in minutes [15]
+    --interval        polling interval in seconds [15 mins]
     --eventsperday    number of events per day to create [10]
     --invitesperday   number of invites per day to send  [5]
     --cache           path to .plist file to cache data [Optional]
@@ -40,7 +40,7 @@
 	- For each non-matching calendar or inbox:
 		- A PROPFIND Depth:1 on the collection.
 		- A multiget report to get new or changed items.
-		- For inbox - iTIP handling is done (not implemented yest).
+		- For inbox - iTIP handling is done (not implemented yet).
 		
     The --interval option controls the polling interval in minutes.
     
@@ -57,19 +57,39 @@
 	
 	The --invitesperday option controls the frequency of these.
 	
-The tool can maintain a cache of the calendar data betwen runs, so that a subsequent start-up can be treated as
+The tool can maintain a cache of the calendar data between runs, so that a subsequent start-up can be treated as
 a client "warm" start rather than a "cold" start. The difference being that a "cold" start requires downloading
 all the calendar data in the first poll, whereas a "warm" start only downloads the changes. The --clear-cache
 option determines whether the existing cache data is used on startup - so when set forces a "cold" start. A
 separate cache file must be used for each user being simulated.
 
-In this implementation the tool sleeps for one minute, then checks the exiry of the three intervals to determine
+In this implementation the tool sleeps for one minute, then checks the expiry of the three intervals to determine
 if an action should be executed. In the longer term we should allow multiple client instances to be run from
 one tool and have a queue of actions set to occur at specific times and a thread pool to service those.
 
-Prequisites: a CalDAV server with user01 .. user99 as user accounts. Those will be used to create the attendees
+Pre-requisites: a CalDAV server with user01 .. user99 as user accounts. Those will be used to create the attendees
 in invites. You can have more users with other names that are used as the simulation user, but they will never
 receive invites (right now).
 
 The tool was designed with the idea that it could be called by another script that can then run multiple instances
 to simulate multiple users. That script could even run the tool on different machines for a distributed test.
+
+Usage: multisim [options]
+Options:
+    --number          number of users to simulate [10]
+    --server          URL for server (e.g. https://caldav.example.com:8443) [Required]
+    --user            user id for user to login as [user%02d]
+    --password        password for user [user%02d]
+    --interval        polling interval in seconds [15 mins]
+    --eventsperday    number of events per day to create [10]
+    --invitesperday   number of invites per day to send  [5]
+    --cache           path to .plist file to cache data [../data/user%02d.plist]
+    --clear-cache     clear the cache when starting up [Optional]
+    --verbose         print out activity log
+    
+    -h, --help        print this help and exit
+
+This tool generates multiple simulations for a range of users (1 through the number specified with the --number
+option). Each simulation is a seperate process running the simulate tool, with the options set for each user
+number. The tool starts all the simulations and then waits for a key press, after which it kills all the simulation
+processes.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20070717/7997033f/attachment.html