rtapi_task_start(3rtapi)

rtapi_task_start3rtapi

Start a realtime task in periodic mode

Usage

int rtapi_task_start(int task_id, unsigned long period_nsec)

Arguments

task_id

A task ID returned by a previous call to rtapi_task_new

period_nsec

The clock period in nanoseconds between iterations of a periodic task

Overview

rtapi_task_start starts a task in periodic mode. The task must be in the paused state.

Realtime considerations

Call only from within init/cleanup code, not from realtime tasks.

Return value

Returns an RTAPI status code.

Releases

Unchanged in 2 releases since Debian 12 (Bookworm).

  1. 12–13

From linuxcnc-uspace-dev 1:2.9.4-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.