rt_task_make_periodic(2)

rt_task_make_periodic2

Mark a real-time task for execution

Usage

#define MODULE
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/version.h>
#include <linux/errno.h>
#include <linux/rt_sched.h>

int rt_task_make_periodic(RT_TASK * task, RTIME start_time, RTIME period);

Overview

rt_task_make_periodic marks a task, previously created with a call to rt_task_init, as ready for execution. The task will run at intervals specified by period; i.e., it will be marked for execution every period real-time clock ticks. The desired start time is specified by start_time; the first execution of the task will occur start_time clock ticks from the current time. If immediate execution is desired, the return value of rt_get_time can be used for start_time.

Return value

On success, 0 is returned. On failure, a negative value is returned as described below.

Errors

-EINVAL

task does not refer to a valid RT_TASK structure.

Releases

Unchanged in 2 releases since Debian 2.2 (Potato).

  1. 2.2–3.0

Author

This manual page was written by Jerry Epplin.

Copyright (C) 1997 Jerry Epplin, placed under the GNU General Public License, see the file copyright for details.

From rtlinux-doc 1.0-2 in Debian 3.0 (Woody). Parsed by carta from the page's man source.