doc/ml_session_args.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_session_pool</title>
   6 </head>
   7 <body>
   8
   9 <h1 align=center>ml_session_pool</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:06:04 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_session_pool, ml_session_args, ml_session_sessionid, ml_session_canonical_path, ml_session_script_name - get monolith per-session information</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 pool ml_session_pool (ml_session);
  38 cgi ml_session_args (ml_session);
  39 const char *ml_session_sessionid (ml_session);
  40 const char *ml_session_canonical_path (ml_session);
  41 const char *ml_session_script_name (ml_session);
  42 </b></pre></td></table>
  43 <a name="DESCRIPTION"></a>
  44 <h2>DESCRIPTION</h2>
  45
  46 <table width="100%" border=0 rules="none" frame="void"
  47        cols="2" cellspacing="0" cellpadding="0">
  48 <tr valign="top" align="left">
  49 <td width="10%"></td><td width="90%">
  50 These functions extract the information from the opaque
  51 <b>ml_session</b> object passed to most application
  52 functions and callbacks. Each separate user session is tied
  53 to a separate <b>ml_session</b> object which contains
  54 standard fields.</td></table>
  55
  56 <table width="100%" border=0 rules="none" frame="void"
  57        cols="2" cellspacing="0" cellpadding="0">
  58 <tr valign="top" align="left">
  59 <td width="10%"></td><td width="90%">
  60 <b>ml_session_pool</b> returns the session pool, which is a
  61 pool which has the lifetime of the whole
  62 session.</td></table>
  63
  64 <table width="100%" border=0 rules="none" frame="void"
  65        cols="2" cellspacing="0" cellpadding="0">
  66 <tr valign="top" align="left">
  67 <td width="10%"></td><td width="90%">
  68 <b>ml_session_args</b> returns the arguments (a <b>cgi</b>
  69 object) which were passed to the application when it started
  70 running. This is kind of equivalent to <b>argc</b> and
  71 <b>argv</b> for a traditional application.</td></table>
  72
  73 <table width="100%" border=0 rules="none" frame="void"
  74        cols="2" cellspacing="0" cellpadding="0">
  75 <tr valign="top" align="left">
  76 <td width="10%"></td><td width="90%">
  77 <b>ml_session_sessionid</b> returns the session ID, a 32
  78 character string of random hex digits which also happens to
  79 be the cookie passed by the browser.</td></table>
  80
  81 <table width="100%" border=0 rules="none" frame="void"
  82        cols="2" cellspacing="0" cellpadding="0">
  83 <tr valign="top" align="left">
  84 <td width="10%"></td><td width="90%">
  85 <b>ml_session_canonical_path</b> returns the canonical path
  86 of the monolith application, that is, the full path of the
  87 application as it appears to the browser. For example
  88 <b>/so-bin/app.so</b>.</td></table>
  89
  90 <table width="100%" border=0 rules="none" frame="void"
  91        cols="2" cellspacing="0" cellpadding="0">
  92 <tr valign="top" align="left">
  93 <td width="10%"></td><td width="90%">
  94 <b>ml_session_script_name</b> returns just the name of the
  95 application as it appears to the browser. For example
  96 <b>app.so</b>.</td></table>
  97 <a name="AUTHOR"></a>
  98 <h2>AUTHOR</h2>
  99
 100 <table width="100%" border=0 rules="none" frame="void"
 101        cols="2" cellspacing="0" cellpadding="0">
 102 <tr valign="top" align="left">
 103 <td width="10%"></td><td width="90%">
 104 Richard Jones &lt;rich@annexia.org&gt;</td></table>
 105 <a name="LICENSE"></a>
 106 <h2>LICENSE</h2>
 107
 108 <table width="100%" border=0 rules="none" frame="void"
 109        cols="2" cellspacing="0" cellpadding="0">
 110 <tr valign="top" align="left">
 111 <td width="10%"></td><td width="90%">
 112 GNU LGPL (see http://www.gnu.org/)</td></table>
 113 <a name="VERSION"></a>
 114 <h2>VERSION</h2>
 115
 116 <table width="100%" border=0 rules="none" frame="void"
 117        cols="2" cellspacing="0" cellpadding="0">
 118 <tr valign="top" align="left">
 119 <td width="10%"></td><td width="90%">
 120 monolith-1.0.0</td></table>
 121 <a name="SEE ALSO"></a>
 122 <h2>SEE ALSO</h2>
 123
 124 <table width="100%" border=0 rules="none" frame="void"
 125        cols="2" cellspacing="0" cellpadding="0">
 126 <tr valign="top" align="left">
 127 <td width="10%"></td><td width="90%">
 128 <b>ml_entry_point(3)</b>, <b>new_cgi(3)</b>.</td></table>
 129 <hr>
 130 </body>
 131 </html>