ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/vendor/libpeak-0.1.2/doc/html/group__stream__sched.html
Revision: 3251
Committed: Wed Apr 2 16:58:30 2014 UTC (9 years, 11 months ago) by michael
Content type: text/html
File size: 5515 byte(s)
Log Message:
- Imported libpeak-0.1.2

File Contents

# Content
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>PEAK Library: Scheduling</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3.5 -->
7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a></div>
8 <h1>Scheduling<br>
9 <small>
10 [<a class="el" href="group__stream.html">Socket streams</a>]</small>
11 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
12 Scheduling task for streams.
13 <p>
14 Well that's the way to really use 'em.
15 <p>
16 <table border=0 cellpadding=0 cellspacing=0>
17 <tr><td></td></tr>
18 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
19 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__stream__sched.html#ga0">peak_stream_schedule</a> (<a class="el" href="group__stream.html#ga0">peak_stream</a> s, <a class="el" href="group__task__common.html#ga0">peak_task</a> task)</td></tr>
20
21 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Schedule a task for a stream. <a href="#ga0"></a><br><br></td></tr>
22 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__stream__sched.html#ga1">peak_stream_unschedule</a> (<a class="el" href="group__stream.html#ga0">peak_stream</a> s, <a class="el" href="group__task__common.html#ga0">peak_task</a> task)</td></tr>
23
24 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unschedule a task for a stream. <a href="#ga1"></a><br><br></td></tr>
25 </table>
26 <hr><h2>Function Documentation</h2>
27 <a class="anchor" name="ga0" doxytag="stream.h::peak_stream_schedule" ></a><p>
28 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
29 <tr>
30 <td class="mdRow">
31 <table cellpadding="0" cellspacing="0" border="0">
32 <tr>
33 <td class="md" nowrap valign="top"> void peak_stream_schedule </td>
34 <td class="md" valign="top">(&nbsp;</td>
35 <td class="md" nowrap valign="top"><a class="el" href="group__stream.html#ga0">peak_stream</a>&nbsp;</td>
36 <td class="mdname" nowrap> <em>s</em>, </td>
37 </tr>
38 <tr>
39 <td></td>
40 <td></td>
41 <td class="md" nowrap><a class="el" href="group__task__common.html#ga0">peak_task</a>&nbsp;</td>
42 <td class="mdname" nowrap> <em>task</em></td>
43 </tr>
44 <tr>
45 <td></td>
46 <td class="md">)&nbsp;</td>
47 <td class="md" colspan="2"></td>
48 </tr>
49
50 </table>
51 </td>
52 </tr>
53 </table>
54 <table cellspacing=5 cellpadding=0 border=0>
55 <tr>
56 <td>
57 &nbsp;
58 </td>
59 <td>
60
61 <p>
62 Schedule a task for a stream.
63 <p>
64 Schedule a task on which you can be notified. It will call your event callback function when an event is available for this stream.<p>
65 <dl compact><dt><b>Parameters:</b></dt><dd>
66 <table border="0" cellspacing="2" cellpadding="0">
67 <tr><td valign=top><em>s</em>&nbsp;</td><td>The stream reference. </td></tr>
68 <tr><td valign=top><em>task</em>&nbsp;</td><td>The task reference (the current implementation only support <a class="el" href="group__task__common.html#ga8">peak_task_self()</a>). </td></tr>
69 </table>
70 </dl>
71 </td>
72 </tr>
73 </table>
74 <a class="anchor" name="ga1" doxytag="stream.h::peak_stream_unschedule" ></a><p>
75 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
76 <tr>
77 <td class="mdRow">
78 <table cellpadding="0" cellspacing="0" border="0">
79 <tr>
80 <td class="md" nowrap valign="top"> void peak_stream_unschedule </td>
81 <td class="md" valign="top">(&nbsp;</td>
82 <td class="md" nowrap valign="top"><a class="el" href="group__stream.html#ga0">peak_stream</a>&nbsp;</td>
83 <td class="mdname" nowrap> <em>s</em>, </td>
84 </tr>
85 <tr>
86 <td></td>
87 <td></td>
88 <td class="md" nowrap><a class="el" href="group__task__common.html#ga0">peak_task</a>&nbsp;</td>
89 <td class="mdname" nowrap> <em>task</em></td>
90 </tr>
91 <tr>
92 <td></td>
93 <td class="md">)&nbsp;</td>
94 <td class="md" colspan="2"></td>
95 </tr>
96
97 </table>
98 </td>
99 </tr>
100 </table>
101 <table cellspacing=5 cellpadding=0 border=0>
102 <tr>
103 <td>
104 &nbsp;
105 </td>
106 <td>
107
108 <p>
109 Unschedule a task for a stream.
110 <p>
111 <dl compact><dt><b>Parameters:</b></dt><dd>
112 <table border="0" cellspacing="2" cellpadding="0">
113 <tr><td valign=top><em>s</em>&nbsp;</td><td>The stream reference. </td></tr>
114 <tr><td valign=top><em>task</em>&nbsp;</td><td>The task reference (the current implementation only support <a class="el" href="group__task__common.html#ga8">peak_task_self()</a>). </td></tr>
115 </table>
116 </dl>
117 </td>
118 </tr>
119 </table>
120 <hr size="1"><address style="align: right;"><small>Generated on Sat Jan 17 21:41:54 2004 for the PEAK Library by
121 <a href="http://www.doxygen.org/index.html">
122 <img src="doxygen.png" alt="doxygen" align="middle" border="0" >
123 </a></small>&nbsp; &nbsp; <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=98146&amp;type=1" width="88" height="31" align="middle" border="0" alt="SourceForge.net Logo" /></a></address>
124 </body>
125 </html>
126