Removed
Link Here
|
1 |
diff -ur docs/reference.html docs/reference.html |
2 |
--- docs/reference.html Fri Oct 25 19:54:20 2002 |
3 |
+++ docs/reference.html Fri Jan 21 15:14:24 2005 |
4 |
@@ -13,6 +13,7 @@ |
5 |
<DL><DD><A HREF=#mutex_t>st_mutex_t</A></DD></DL> |
6 |
<DL><DD><A HREF=#utime_t>st_utime_t</A></DD></DL> |
7 |
<DL><DD><A HREF=#netfd_t>st_netfd_t</A></DD></DL> |
8 |
+<DL><DD><A HREF=#switch_cb_t>st_switch_cb_t</A></DD></DL> |
9 |
<P> |
10 |
<DD><A HREF=#errors><B>Error Handling</B></A></DD> |
11 |
<P> |
12 |
@@ -20,6 +21,8 @@ |
13 |
<P> |
14 |
<DL><DD><A HREF=#st_init>st_init()</A></DD></DL> |
15 |
<DL><DD><A HREF=#st_getfdlimit>st_getfdlimit()</A></DD></DL> |
16 |
+<DL><DD><A HREF=#st_set_switch_in_cb>st_set_switch_in_cb()</A></DD></DL> |
17 |
+<DL><DD><A HREF=#st_set_switch_out_cb>st_set_switch_out_cb()</A></DD></DL> |
18 |
<P> |
19 |
<DD><A HREF=#threads><B>Thread Control and Identification</B></A></DD> |
20 |
<P> |
21 |
@@ -244,6 +247,29 @@ |
22 |
<HR> |
23 |
<P> |
24 |
|
25 |
+<A NAME="switch_cb_t"> |
26 |
+<H4>st_switch_cb_t</H4> |
27 |
+</A> |
28 |
+Context switch callback function type. |
29 |
+<P> |
30 |
+<H5>Syntax</H5> |
31 |
+ |
32 |
+<PRE> |
33 |
+#include <st.h> |
34 |
+ |
35 |
+typedef void (*st_switch_cb_t)(void); |
36 |
+</PRE> |
37 |
+<P> |
38 |
+<H5>Description</H5> |
39 |
+ |
40 |
+This datatype is a convenience type for describing a pointer |
41 |
+to a function that will be called when a thread is set to stop |
42 |
+or set to run. |
43 |
+ |
44 |
+<P> |
45 |
+<HR> |
46 |
+<P> |
47 |
+ |
48 |
<A NAME="errors"> |
49 |
<H2>Error Handling</H2> |
50 |
</A> |
51 |
@@ -267,6 +293,8 @@ |
52 |
<DL> |
53 |
<DD><A HREF=#st_init>st_init()</A></DD> |
54 |
<DD><A HREF=#st_getfdlimit>st_getfdlimit()</A></DD> |
55 |
+<DD><A HREF=#st_set_switch_in_cb>st_set_switch_in_cb()</A></DD> |
56 |
+<DD><A HREF=#st_set_switch_out_cb>st_set_switch_out_cb()</A></DD> |
57 |
</DL> |
58 |
<P> |
59 |
<HR> |
60 |
@@ -343,6 +371,41 @@ |
61 |
<H5>Description</H5> |
62 |
This function returns the limit on the number of open file descriptors which |
63 |
is set by the <A HREF=#st_init>st_init()</A> function. |
64 |
+<P> |
65 |
+<HR> |
66 |
+<P> |
67 |
+ |
68 |
+<A NAME="st_set_switch_in_cb"> |
69 |
+<H4>st_set_switch_in_cb()</H4> |
70 |
+</A> |
71 |
+<A NAME="st_set_switch_out_cb"> |
72 |
+<H4>st_set_switch_out_cb()</H4> |
73 |
+</A> |
74 |
+Set the callback function for thread switches. |
75 |
+<P> |
76 |
+<H5>Syntax</H5> |
77 |
+ |
78 |
+<PRE> |
79 |
+#include <st.h> |
80 |
+ |
81 |
+st_switch_cb_t st_set_switch_in_cb(st_switch_cb_t cb); |
82 |
+st_switch_cb_t st_set_switch_out_cb(st_switch_cb_t cb); |
83 |
+</PRE> |
84 |
+<P> |
85 |
+<H5>Parameters</H5> |
86 |
+<TT>st_set_switch_in_cb()</TT> and <TT>st_set_switch_out_cb()</TT> have the |
87 |
+following parameter:<P> |
88 |
+<TT>cb</TT><P> |
89 |
+A function to be called when a thread is resumed and stopped respectively.<P> |
90 |
+<H5>Returns</H5> |
91 |
+The previous callback function pointer. |
92 |
+<P> |
93 |
+<H5>Description</H5> |
94 |
+These functions set the callback for when a thread is resumed and stopped |
95 |
+respectively. After being called any thread switch will call the callback. |
96 |
+It is suggested that thread specific data is used to differentiate between |
97 |
+different threads.<P> |
98 |
+These functions can be called at any time. |
99 |
<P> |
100 |
<HR> |
101 |
<P> |