WUT_cb.h File Reference

WakeUp Timer, WUT callback routine and return value definition. More...

Typedefs
typedef enum _WUT_cb_status	WUT_cb_status
	Typedef for enum _WUT_cb_status.
typedef WUT_cb_status(*	WUT_cb_routine )(void *prm, WUT_tmr *wut)
	Define the callback routine signature.
Enumerations
enum	_WUT_cb_status {   WUT_K_STATE_CHANGE_NO = 0,   WUT_K_STATE_CHANGE_YES = 1 }
	Enumerates the various values of a WUT callable service routine. More...

---

Detailed Description

WakeUp Timer, WUT callback routine and return value definition.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: WUT_cb.h,v 1.2 2003/08/20 17:37:02 russell Exp $

---

Typedef Documentation

WUT_cb_routine

Define the callback routine signature.

The callback signature of a WUT interupt servicing routine is

      WUT_cb_status = (*WUT_cb_routine) (void *prm, WUT_tmr *wut);

    where:
        prm: Is a parameter established when creating the timer entry
             and passed transparently through to the callback routine.
        wut: The WUT timer handle 
        
    The return value should be
 
     WUT_K_STATE_CHANGE_NO  - if the state of the WUT handle did not change
     WUT_K_STATE_CHANGE_YES - if the state of the WUT handle did     change
 
    The state of the WUT handle will change if the user successfully
    performs any of the following calls in the callback routine.
 
     WUT_cancel
     WUT_start
     WUT_restart
     WUT_destroy
  
    If the state is not changed by the user, it is marked as WUT_K_EXPIRED
    by the WUT_service.
   

WUT_cb_status

Typedef for enum _WUT_cb_status.

The WUT Interrupt Service Routine is obligated to pass back one of two values. Either WUT_K_STATE_CHANGE_NO, indicating that the user has not changed the state of the WUT control structure, or WUT_K_STATE_CHANGE_YES, indicating the state has been changed, for example by calling WUT_restart() or WUT_destroy().

---

Enumeration Type Documentation

enum _WUT_cb_status

Enumerates the various values of a WUT callable service routine.

Enumerator:

WUT_K_STATE_CHANGE_NO	ISR routine has not changed the state
WUT_K_STATE_CHANGE_YES	ISR routine has changed the state