MON_poll.h File Reference

Interface to the CPU monitor polling task. More...

#include <MON/MON_pubdefs.h>
#include <MON_idle.h>
#include <MON_perf.h>
#include <PBS/MTX.h>
#include <PBS/TASK.h>

Classes
struct	_MON_Poll_Control
	Polling function control information block. More...
Typedefs
typedef struct _MON_Poll_Control	MON_Poll_Control
	Typedef for _MON_Poll_Control.
Functions
unsigned int	MON_poll_init (MON_Poll_Control *ctl_p, MON_Idle_Control *idle_p, MON_Perf_Control *perf_p, MTX *mtx_p)
	Initialize the POLL task.
unsigned int	MON_poll_shutdown (MON_Poll_Control *ctl_p)
	Shutdown the POLL task.
unsigned int	MON_poll_start (MON_Poll_Control *ctl_p, TASK_attr *attr_p)
	Start the POLL task.
unsigned int	MON_poll_stop (MON_Poll_Control *ctl_p)
	Stop the POLL task.

---

Detailed Description

Interface to the CPU monitor polling task.

**  CVS $Id: MON_poll.h,v 1.4 2011/03/28 23:52:03 russell Exp $
**  

Defines the interface to the functions found in MON_poll.c.

---

Function Documentation

unsigned int MON_poll_init	(	MON_Poll_Control *	ctl_p,
		MON_Idle_Control *	idle_p,
		MON_Perf_Control *	perf_p,
		MTX *	mtx_p
	)

Initialize the POLL task.

Parameters:

	ctl_p	Pointer to POLL state.
	idle_p	Pointer to IDLE monitor state.
	perf_p	Pointer to performance monitor state.
	mtx_p	Pointer to control block access MUTEX.

Returns:

MSG code.

References _MON_Poll_Control::idle_p, _MON_Poll_Control::mtx_p, _MON_Poll_Control::perf_p, and _MON_Poll_Control::tcb_p.

Referenced by MON_initialize().

unsigned int MON_poll_shutdown

(

MON_Poll_Control *

ctl_p

)

Shutdown the POLL task.

Parameters:

ctl_p

Pointer to POLL state.

Returns:

MSG code.

References _MON_Poll_Control::tcb_p.

Referenced by MON_shutdown().

unsigned int MON_poll_start	(	MON_Poll_Control *	ctl_p,
		TASK_attr *	attr_p
	)

Start the POLL task.

Parameters:

	ctl_p	Pointer to POLL state.
	attr_p	Pointer to POLL task attributes.

Returns:

MSG code.

References mon_poll_task(), _MON_Poll_Control::run, and _MON_Poll_Control::tcb_p.

Referenced by MON_start().

unsigned int MON_poll_stop

(

MON_Poll_Control *

ctl_p

)

Stop the POLL task.

Parameters:

ctl_p

Pointer to POLL state.

Returns:

MSG code.

References _MON_Poll_Control::run, and _MON_Poll_Control::tcb_p.

Referenced by MON_stop().