rtf_create_handler(2)

NAME

rtf_create_handler - install a handler for real-time fifo data

SYNOPSIS

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

int rtf_create_handler(unsigned int fifo, int (* handler)(unsigned int fifo));

DESCRIPTION

rtf_create_handler installs a handler which is executed when data is written to or read from a real-time fifo (RT-FIFO). fifo is an RT-FIFO that must have previously been created with a call to rtf_create_fifo. handler is then called whenever a Linux process accesses that fifo.

rtf_create_handler is often used in conjunction with rtf_get to process data acquired asynchronously from a Linux process. The installed handler calls rtf_get when data is present. Because the handler is only executed when there is activity on the fifo, polling is not necessary.

The RT-FIFO is a mechanism, implemented as a character device, to communicate between real-time tasks and ordinary Linux processes. The rtf_* functions are used by the real-time tasks; Linux processes use standard character device access functions such as read(2), write(2), and select(2).

RETURN VALUE

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

ERRORS

-EINVAL: fifo is greater than or equal to RTF_NO, or is not a valid RT-FIFO identifier; or handler is NULL.

AUTHOR

This manual page was written by Jerry Epplin.