1 |
\hypertarget{group__stream__sched}{ |
2 |
\section{Scheduling} |
3 |
\label{group__stream__sched}\index{Scheduling@{Scheduling}} |
4 |
} |
5 |
|
6 |
|
7 |
\subsection{Detailed Description} |
8 |
Scheduling task for streams. |
9 |
|
10 |
Well that's the way to really use 'em. |
11 |
|
12 |
\subsection*{Functions} |
13 |
\begin{CompactItemize} |
14 |
\item |
15 |
void \hyperlink{group__stream__sched_ga0}{peak\_\-stream\_\-schedule} (\hyperlink{group__stream_ga0}{peak\_\-stream} s, \hyperlink{group__task__common_ga0}{peak\_\-task} task) |
16 |
\begin{CompactList}\small\item\em Schedule a task for a stream. \item\end{CompactList}\item |
17 |
void \hyperlink{group__stream__sched_ga1}{peak\_\-stream\_\-unschedule} (\hyperlink{group__stream_ga0}{peak\_\-stream} s, \hyperlink{group__task__common_ga0}{peak\_\-task} task) |
18 |
\begin{CompactList}\small\item\em Unschedule a task for a stream. \item\end{CompactList}\end{CompactItemize} |
19 |
|
20 |
|
21 |
\subsection{Function Documentation} |
22 |
\hypertarget{group__stream__sched_ga0}{ |
23 |
\index{stream_sched@{stream\_\-sched}!peak_stream_schedule@{peak\_\-stream\_\-schedule}} |
24 |
\index{peak_stream_schedule@{peak\_\-stream\_\-schedule}!stream_sched@{stream\_\-sched}} |
25 |
\subsubsection[peak\_\-stream\_\-schedule]{\setlength{\rightskip}{0pt plus 5cm}void peak\_\-stream\_\-schedule (\hyperlink{group__stream_ga0}{peak\_\-stream} {\em s}, \hyperlink{group__task__common_ga0}{peak\_\-task} {\em task})}} |
26 |
\label{group__stream__sched_ga0} |
27 |
|
28 |
|
29 |
Schedule a task for a stream. |
30 |
|
31 |
Schedule a task on which you can be notified. It will call your event callback function when an event is available for this stream. |
32 |
|
33 |
\begin{Desc} |
34 |
\item[Parameters:] |
35 |
\begin{description} |
36 |
\item[{\em s}]The stream reference. \item[{\em task}]The task reference (the current implementation only support \hyperlink{group__task__common_ga8}{peak\_\-task\_\-self()}). \end{description} |
37 |
\end{Desc} |
38 |
\hypertarget{group__stream__sched_ga1}{ |
39 |
\index{stream_sched@{stream\_\-sched}!peak_stream_unschedule@{peak\_\-stream\_\-unschedule}} |
40 |
\index{peak_stream_unschedule@{peak\_\-stream\_\-unschedule}!stream_sched@{stream\_\-sched}} |
41 |
\subsubsection[peak\_\-stream\_\-unschedule]{\setlength{\rightskip}{0pt plus 5cm}void peak\_\-stream\_\-unschedule (\hyperlink{group__stream_ga0}{peak\_\-stream} {\em s}, \hyperlink{group__task__common_ga0}{peak\_\-task} {\em task})}} |
42 |
\label{group__stream__sched_ga1} |
43 |
|
44 |
|
45 |
Unschedule a task for a stream. |
46 |
|
47 |
\begin{Desc} |
48 |
\item[Parameters:] |
49 |
\begin{description} |
50 |
\item[{\em s}]The stream reference. \item[{\em task}]The task reference (the current implementation only support \hyperlink{group__task__common_ga8}{peak\_\-task\_\-self()}). \end{description} |
51 |
\end{Desc} |