/tmp/l4check/full_tree/trunk/l4/pkg/rt_mon/include/event_list.h File Reference

Some functions to work with event lists. More...

#include <l4/rt_mon/types.h>

Go to the source code of this file.

Functions
EXTERN_C_BEGIN rt_mon_event_list_t *	rt_mon_list_create (int event_size, int event_type, int event_count, const char *name, const char *unit, int clock, int shared)
	Creates a new event_list, allocates memory for it and registers it at the coordinator.
void	rt_mon_list_free (rt_mon_event_list_t *list)
	Destroys an event_list, unregisters it at the coordinator and frees its memory.
void	rt_mon_list_insert (rt_mon_event_list_t *list, const void *event)
	Insert event into event_list.
rt_mon_time_t	rt_mon_list_measure (rt_mon_event_list_t *list)
	Get a time stamp using the timesource specified in list.
int	rt_mon_list_remove (rt_mon_event_list_t *list, void *event)
	Get (move) an event from list.
void	rt_mon_list_dump (rt_mon_event_list_t *list)
	Dump the content of an event_list using printf.

---

Detailed Description

Some functions to work with event lists.

Date:

08/20/2004

Author:

Martin Pohlack <mp26@os.inf.tu-dresden.de>

---

Function Documentation

EXTERN_C_BEGIN rt_mon_event_list_t* rt_mon_list_create	(	int	event_size,
		int	event_type,
		int	event_count,
		const char *	name,
		const char *	unit,
		int	clock,
		int	shared
	)

Creates a new event_list, allocates memory for it and registers it at the coordinator.

Parameters:

	event_size	Size in bytes of all events in this event_list
	event_type	typecode for the events, can be used to distinguish lists with different event types in monitors
	event_count	number of events to allocate memory buffer for
	name	name of this event_list
	unit	measurement unit of data transported in the events in this event_list
	clock	type of time source to use for this sensor
	shared	boolean flag whether to use a shared datastructure

Returns:

pointer to newly malloc'ed, registered and initialized event_list, otherwise

• NULL in case of error (like out of memory)

void rt_mon_list_dump

(

rt_mon_event_list_t *

list

)

Dump the content of an event_list using printf.

Parameters:

list

event_list to dump

void rt_mon_list_free

(

rt_mon_event_list_t *

list

)

Destroys an event_list, unregisters it at the coordinator and frees its memory.

Parameters:

list

event_list to free

void rt_mon_list_insert	(	rt_mon_event_list_t *	list,
		const void *	event
	)			[inline]

Insert event into event_list.

Parameters:

	list	event_list to insert to
	event	event to insert

rt_mon_time_t rt_mon_list_measure

(

rt_mon_event_list_t *

list

)

[inline]

Get a time stamp using the timesource specified in list.

Parameters:

list

event_list to get the time source type from

Returns:

the time measured

int rt_mon_list_remove	(	rt_mon_event_list_t *	list,
		void *	event
	)			[inline]

Get (move) an event from list.

Parameters:

	list	event_list to get the event from
	event	pointer to event struct to move event to

Returns:

0 on success,

• otherwise: no event available