rt_task_wait

Name

rt_task_wait -- suspend execution for the current period until the next period

Synopsis

       WARNING - 
       This is an RTLinux v1.x compatibility function.  
	For new programs, please see pthread_wait_np(3).

       #define MODULE
       #include <linux/module.h>
       #include <linux/kernel.h>
       #include <linux/version.h>
       #include <linux/errno.h>
       #include <linux/rtf.h>
       #include <asm/rt_irq.h>

       int rt_task_wait(void);

WARNING

This is an RTLinux v1.x compatibility function. For new programs, please see pthread_wait_np(3).

DESCRIPTION

rt_task_wait blocks the currently running realtime task until the start of the next period. The task was previously marked for execution using rt_task_make_periodic.

The task is not suspended; this is done instead by rt_task_suspend. Instead, it simply gives up control until the next time period.

RETURN VALUE

Always returns 0.

ERRORS

None.

AUTHOR

Jerry Epplin. Modified by Michael Barabanov (baraban@fsmlabs.com)

SEE ALSO

rt_get_time(3), rt_task_delete(3), rt_task_init(3), rt_task_make_periodic(3), rt_task_suspend(3), pthread_wait_np(3)

1997 Jerry Epplin.

Modifications for RTLinux 2.x and 3.x by Michael Barabanov. 2001 FSMLabs Inc.

All rights reserved.