Add to git.
[monolith.git] / doc / ml_entry_point.3.html
1 <html>
2 <head>
3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>ml_entry_point</title>
6 </head>
7 <body>
8
9 <h1 align=center>ml_entry_point</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#AUTHOR">AUTHOR</a><br>
14 <a href="#LICENSE">LICENSE</a><br>
15 <a href="#VERSION">VERSION</a><br>
16 <a href="#SEE ALSO">SEE ALSO</a><br>
17
18 <hr>
19 <!-- Creator     : groff version 1.17.2 -->
20 <!-- CreationDate: Sat Aug 31 18:05:53 2002 -->
21 <a name="NAME"></a>
22 <h2>NAME</h2>
23 <table width="100%" border=0 rules="none" frame="void"
24        cols="2" cellspacing="0" cellpadding="0">
25 <tr valign="top" align="left">
26 <td width="10%"></td><td width="90%">
27 ml_entry_point - entry point into monolith from handle_request</td></table>
28 <a name="SYNOPSIS"></a>
29 <h2>SYNOPSIS</h2>
30
31 <table width="100%" border=0 rules="none" frame="void"
32        cols="2" cellspacing="0" cellpadding="0">
33 <tr valign="top" align="left">
34 <td width="10%"></td><td width="90%">
35 <pre><b>#include &lt;monolith.h&gt;
36
37 int ml_entry_point (rws_request rq, void (*app_main) (ml_session));
38 </b></pre></td></table>
39 <a name="DESCRIPTION"></a>
40 <h2>DESCRIPTION</h2>
41
42 <table width="100%" border=0 rules="none" frame="void"
43        cols="2" cellspacing="0" cellpadding="0">
44 <tr valign="top" align="left">
45 <td width="10%"></td><td width="90%">
46 <b>ml_entry_point</b> is the entry point into the monolith
47 core library code, called from <b>handle_request</b>. The
48 application's <b>handle_request</b> function should contain
49 just a single call to <b>ml_entry_point</b> like
50 this:</td></table>
51
52 <table width="100%" border=0 rules="none" frame="void"
53        cols="2" cellspacing="0" cellpadding="0">
54 <tr valign="top" align="left">
55 <td width="10%"></td><td width="90%">
56 <b>return ml_entry_point (rq, app_main);</b></td></table>
57
58 <table width="100%" border=0 rules="none" frame="void"
59        cols="2" cellspacing="0" cellpadding="0">
60 <tr valign="top" align="left">
61 <td width="10%"></td><td width="90%">
62 where <b>rq</b> is the <b>rws_request</b> object passed by
63 the web server, and <b>app_main</b> is the application's
64 main function.</td></table>
65
66 <table width="100%" border=0 rules="none" frame="void"
67        cols="2" cellspacing="0" cellpadding="0">
68 <tr valign="top" align="left">
69 <td width="10%"></td><td width="90%">
70 See <b>examples/01_label_and_button.c</b> for a simple
71 monolith application.</td></table>
72 <a name="AUTHOR"></a>
73 <h2>AUTHOR</h2>
74
75 <table width="100%" border=0 rules="none" frame="void"
76        cols="2" cellspacing="0" cellpadding="0">
77 <tr valign="top" align="left">
78 <td width="10%"></td><td width="90%">
79 Richard Jones &lt;rich@annexia.org&gt;</td></table>
80 <a name="LICENSE"></a>
81 <h2>LICENSE</h2>
82
83 <table width="100%" border=0 rules="none" frame="void"
84        cols="2" cellspacing="0" cellpadding="0">
85 <tr valign="top" align="left">
86 <td width="10%"></td><td width="90%">
87 GNU LGPL (see http://www.gnu.org/)</td></table>
88 <a name="VERSION"></a>
89 <h2>VERSION</h2>
90
91 <table width="100%" border=0 rules="none" frame="void"
92        cols="2" cellspacing="0" cellpadding="0">
93 <tr valign="top" align="left">
94 <td width="10%"></td><td width="90%">
95 monolith-1.0.0</td></table>
96 <a name="SEE ALSO"></a>
97 <h2>SEE ALSO</h2>
98
99 <table width="100%" border=0 rules="none" frame="void"
100        cols="2" cellspacing="0" cellpadding="0">
101 <tr valign="top" align="left">
102 <td width="10%"></td><td width="90%">
103 <b>ml_session_pool(3)</b>, <b>rws_request_pool(3)</b>,
104 <b>new_ml_window(3)</b>.</td></table>
105 <hr>
106 </body>
107 </html>