diff options
| author | Rob Taylor <rob.taylor@codethink.co.uk> | 2007-08-18 15:24:58 +0100 |
|---|---|---|
| committer | Rob Taylor <rob.taylor@codethink.co.uk> | 2007-08-22 15:17:50 +0100 |
| commit | c6b1dc765bd1f769bf8e365795f9a798e920e82d (patch) | |
| tree | cdf46df62a66f61a39fbebf0fe87ed95a3cfa4e1 | |
| parent | 3b24523a7763c76524bd965eefb73276f120ed28 (diff) | |
document idle plugin usage.
Document idle plugin usage.
| -rw-r--r-- | plugins/glue/idle/README | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/plugins/glue/idle/README b/plugins/glue/idle/README index 0db68d7..b00f58d 100644 --- a/plugins/glue/idle/README +++ b/plugins/glue/idle/README @@ -1 +1,16 @@ -Todo +OHM Idle Plugin +--------------- +The OHM Idle plugin is used to discover when there have been varying lengths +of user input inactivity. + +The idle plugin exposes 2 keys: + * idle.state + * idle.timeout + +When there is user activity, idle.state will be set to 0. +After idle.timeout milliseconds idle.state will be incremented. + +If a policy wishes to measure, say 2 different lengths of user inactibity, they +may set timeout to a new value when idle.state is incremented. When that new timout expires, idle.state will be incremented again, and so on. + +See defualt policy module 'timeouts' for an example. |