Made some fixes to the conditions section.
authorTerry L. Wilmarth <wilmarth@uiuc.edu>
Wed, 23 Jul 1997 17:42:18 +0000 (17:42 +0000)
committerTerry L. Wilmarth <wilmarth@uiuc.edu>
Wed, 23 Jul 1997 17:42:18 +0000 (17:42 +0000)
doc/converse/conditions.tex

index ecf6cb338841c507b89e0580818b38b6fdced0f2..91fd90df7bc6737ac6b24b11513fbfccbfc4eb23 100644 (file)
@@ -1,10 +1,10 @@
 
 
-\chapter{Timers, periodic checks, and conditions}
+\chapter{Timers, Periodic Checks, and Conditions}
 
-This module provides functions that allow users to insert hooks, that
-is user supplied functions that are called by the system at specified
-times, or as specific conditions arise.
+This module provides functions that allow users to insert hooks,
+i.e. user-supplied functions, that are called by the system at
+specified times, or as specific conditions arise.
 
 {\bf  CcdCallOnCondition}
 \begin{verbatim}
@@ -14,18 +14,18 @@ void CcdCallOnCondition(condnum,fnp,arg)
     void *arg;      
 \end{verbatim}
 
-This called instructs the system to call the function indicated by the
-function pointer fnp, with the specified argument arg, when the
-condition indicated by condnum is raised next. Multiple functions may
+This call instructs the system to call the function indicated by the
+function pointer {\tt fnp}, with the specified argument {\tt arg}, when the
+condition indicated by {\tt condnum} is raised next. Multiple functions may
 be registered for the same condition number. A total of 511
-conditions, numbered one through 511, are supported.  Currently, users
+conditions, numbered 1 through 511, are supported.  Currently, users
 must make sure that various condition numbers used in a program are
-disjoint.  (In future, we may provide a call to allocate the next
+disjoint.  (In the future, we may provide a call to allocate the next
 available condition number.)
 
 The system supports a predefined condition, with condition number 1
 (CcdPROCESSORIDLE, BUT I AM AM NOT SURE THAT IS EXPORTED TO THE USER
-PROGRAM), which is raised by the system when they are no entities
+PROGRAM), which is raised by the system when there are no entities
 (ready threads, messages for objects, posted handlers, etc.) in the
 scheduler's queue.
 
@@ -38,11 +38,12 @@ void CcdRaiseCondition(condNum)
 
 When this function is called, it invokes all the functions whose
 pointers were registered for the \verb#condNum# via a {\em prior} call
-to CcdCallOnCondition(..).  All calls to CcdCallOnCondition(..) {\em
-during} this function's execution take effect only after this function
-returns.  Once a user-registered function is called, it loses its
-registration.  So, if users want the function to be called the next
-time the same condition arises, they must register the function again.
+to {\tt CcdCallOnCondition(..)}.  All calls to {\tt
+CcdCallOnCondition(..)} {\em during} this function's execution takes
+effect only after it returns.  Once a user-registered
+function is called, it loses its registration.  So, if users want the
+function to be called the next time the same condition arises, they
+must register the function again.
 
 \vspace*{0.2in}
 {\bf  CcdPeriodicallyCall}
@@ -52,7 +53,7 @@ void CcdPeriodicallyCall(fnp, arg)
     void *arg;  
 \end{verbatim}
 
-To function registered through this call is called periodically by the
+A function registered through this call is called periodically by the
 system's scheduler.  Typically, it would be called every time the
 scheduler gets control, such as while switching context to a new
 thread or before scheduling a message for an object, or before calling
@@ -68,8 +69,8 @@ void CcdCallFnAfter(fnp, arg, deltaT)
     unsigned int deltaT; 
 \end{verbatim}
 
-This call registers a function via a pointer to it, fnp,  that will be
-called at least deltaT milliseconds later. 
-The registered function fnp is actually called the first time
-scheduler gets control after deltaT milliseconds have elapsed. 
+This call registers a function via a pointer to it, {\tt fnp},  that will be
+called at least {\tt deltaT} milliseconds later. 
+The registered function {\tt fnp} is actually called the first time the
+scheduler gets control after {\tt deltaT} milliseconds have elapsed.