1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4
<link rel="STYLESHEET" href="modpython.css" type='text/css'>
5
<link rel="first" href="modpython.html" title='Mod_python Manual'>
6
<link rel='contents' href='contents.html' title="Contents">
7
<link rel='index' href='genindex.html' title='Index'>
8
<link rel='last' href='about.html' title='About this document...'>
9
<link rel='help' href='about.html' title='About this document...'>
10
<LINK REL="next" href="pyapi-mpsrv-mem.html">
11
<LINK REL="prev" href="pyapi-mpserver.html">
12
<LINK REL="parent" href="pyapi-mpserver.html">
13
<LINK REL="next" href="pyapi-mpsrv-mem.html">
14
<meta name='aesop' content='information'>
15
<META NAME="description" CONTENT="Server Methods">
16
<META NAME="keywords" CONTENT="modpython">
17
<META NAME="resource-type" CONTENT="document">
18
<META NAME="distribution" CONTENT="global">
19
<title>4.5.6.1 Server Methods</title>
4
<link rel="STYLESHEET" href="modpython.css" type='text/css' />
5
<link rel="first" href="modpython.html" title='Mod_python Manual' />
6
<link rel='contents' href='contents.html' title="Contents" />
7
<link rel='index' href='genindex.html' title='Index' />
8
<link rel='last' href='about.html' title='About this document...' />
9
<link rel='help' href='about.html' title='About this document...' />
10
<link rel="next" href="pyapi-mpsrv-mem.html" />
11
<link rel="prev" href="pyapi-mpserver.html" />
12
<link rel="parent" href="pyapi-mpserver.html" />
13
<link rel="next" href="pyapi-mpsrv-mem.html" />
14
<meta name='aesop' content='information' />
15
<title>4.5.7.1 Server Methods</title>
22
18
<DIV CLASS="navigation">
19
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
23
20
<table align="center" width="100%" cellpadding="0" cellspacing="2">
25
<td><a rel="prev" title="4.5.6 Server Object (mp_server) "
26
href="pyapi-mpserver.html"><img src='previous.gif'
27
border='0' height='32' alt='Previous Page' width='32'></A></td>
28
<td><a rel="parent" title="4.5.6 Server Object (mp_server) "
29
href="pyapi-mpserver.html"><img src='up.gif'
30
border='0' height='32' alt='Up One Level' width='32'></A></td>
31
<td><a rel="next" title="4.5.6.2 Server Members"
32
href="pyapi-mpsrv-mem.html"><img src='next.gif'
33
border='0' height='32' alt='Next Page' width='32'></A></td>
22
<td class='online-navigation'><a rel="prev" title="4.5.7 Server Object (mp_server)"
23
href="pyapi-mpserver.html"><img src='previous.png'
24
border='0' height='32' alt='Previous Page' width='32' /></A></td>
25
<td class='online-navigation'><a rel="parent" title="4.5.7 Server Object (mp_server)"
26
href="pyapi-mpserver.html"><img src='up.png'
27
border='0' height='32' alt='Up One Level' width='32' /></A></td>
28
<td class='online-navigation'><a rel="next" title="4.5.7.2 Server Members"
29
href="pyapi-mpsrv-mem.html"><img src='next.png'
30
border='0' height='32' alt='Next Page' width='32' /></A></td>
34
31
<td align="center" width="100%">Mod_python Manual</td>
35
<td><a rel="contents" title="Table of Contents"
36
href="contents.html"><img src='contents.gif'
37
border='0' height='32' alt='Contents' width='32'></A></td>
38
<td><img src='blank.gif'
39
border='0' height='32' alt='' width='32'></td>
40
<td><a rel="index" title="Index"
41
href="genindex.html"><img src='index.gif'
42
border='0' height='32' alt='Index' width='32'></A></td>
32
<td class='online-navigation'><a rel="contents" title="Table of Contents"
33
href="contents.html"><img src='contents.png'
34
border='0' height='32' alt='Contents' width='32' /></A></td>
35
<td class='online-navigation'><img src='blank.png'
36
border='0' height='32' alt='' width='32' /></td>
37
<td class='online-navigation'><a rel="index" title="Index"
38
href="genindex.html"><img src='index.png'
39
border='0' height='32' alt='Index' width='32' /></A></td>
41
<div class='online-navigation'>
44
42
<b class="navlabel">Previous:</b>
45
<a class="sectref" rel="prev" href="pyapi-mpserver.html">4.5.6 Server Object (mp_server) </A>
43
<a class="sectref" rel="prev" href="pyapi-mpserver.html">4.5.7 Server Object (mp_server)</A>
46
44
<b class="navlabel">Up:</b>
47
<a class="sectref" rel="parent" href="pyapi-mpserver.html">4.5.6 Server Object (mp_server) </A>
45
<a class="sectref" rel="parent" href="pyapi-mpserver.html">4.5.7 Server Object (mp_server)</A>
48
46
<b class="navlabel">Next:</b>
49
<a class="sectref" rel="next" href="pyapi-mpsrv-mem.html">4.5.6.2 Server Members</A>
47
<a class="sectref" rel="next" href="pyapi-mpsrv-mem.html">4.5.7.2 Server Members</A>
52
51
<!--End of Navigation Panel-->
54
<H3><A NAME="SECTION006561000000000000000"> </A>
53
<H3><A NAME="SECTION006571000000000000000"></A><A NAME="pyapi-mpsrv-meth"></A>
56
4.5.6.1 Server Methods
55
4.5.7.1 Server Methods
60
59
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
61
<td><nobr><b><a name="l2h-165"><tt class="method">get_config</tt></a></b>(</nobr></td>
62
<td>)</td></tr></table>
60
<td><nobr><b><tt id='l2h-180' xml:id='l2h-180' class="method">get_config</tt></b>(</nobr></td>
61
<td><var></var>)</td></tr></table></dt>
64
Similar to <code>req.get_config()</code>, but returns a config pointed to
65
by <code>server->module_config</code> Apache config vector.
63
Similar to <code>req.get_config()</code>, but returns a table object holding
64
only the mod_python configuration defined at global scope within the
65
Apache configuration. That is, outside of the context of any VirtualHost,
66
Location, Directory or Files directives.
69
70
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
70
<td><nobr><b><a name="l2h-166"><tt class="method">get_options</tt></a></b>(</nobr></td>
71
<td>)</td></tr></table>
71
<td><nobr><b><tt id='l2h-181' xml:id='l2h-181' class="method">get_options</tt></b>(</nobr></td>
72
<td><var></var>)</td></tr></table></dt>
73
74
Similar to <code>req.get_options()</code>, but returns a table object holding
74
75
only the mod_python options defined at global scope within the Apache
80
81
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
81
<td><nobr><b><a name="l2h-167"><tt class="method">register_cleanup</tt></a></b>(</nobr></td>
82
<td><var>request, callable</var><big>[</big><var>, data</var><big>]</big>)</td></tr></table>
82
<td><nobr><b><tt id='l2h-182' xml:id='l2h-182' class="method">log_error</tt></b>(</nobr></td>
83
<td><var>message</var><big>[</big><var>, level</var><big>]</big><var></var>)</td></tr></table></dt>
85
An interface to the Apache <code>ap_log_error</code>
86
function. <var>message</var> is a string with the error message,
87
<var>level</var> is one of the following flags constants:
90
<div class="verbatim"><pre>
103
If you need to write to log and do not have a reference to a server or
104
request object, use the <tt class="function">apache.log_error</tt> function.
108
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
109
<td><nobr><b><tt id='l2h-183' xml:id='l2h-183' class="method">register_cleanup</tt></b>(</nobr></td>
110
<td><var>request, callable</var><big>[</big><var>, data</var><big>]</big><var></var>)</td></tr></table></dt>
84
112
Registers a cleanup. Very similar to <tt class="function">req.register_cleanup()</tt>, except
85
113
this cleanup will be executed at child termination time. This function
86
requires one extra argument - the request object.
114
requires the request object be supplied to infer the interpreter name.
115
If you don't have any request object at hand, then you must use the
116
<tt class="function">apache.register_cleanup</tt> variant.
117
<em>Warning:</em> do not pass directly or indirectly a request object in the
118
data parameter. Since the callable will be called at server shutdown time,
119
the request object won't exist anymore and any manipulation of it in the
120
callable will give undefined behaviour.
91
125
<DIV CLASS="navigation">
126
<div class='online-navigation'>
93
128
<table align="center" width="100%" cellpadding="0" cellspacing="2">
95
<td><a rel="prev" title="4.5.6 Server Object (mp_server) "
96
rel="prev" title="4.5.6 Server Object (mp_server) "
97
href="pyapi-mpserver.html"><img src='previous.gif'
98
border='0' height='32' alt='Previous Page' width='32'></A></td>
99
<td><a rel="parent" title="4.5.6 Server Object (mp_server) "
100
rel="parent" title="4.5.6 Server Object (mp_server) "
101
href="pyapi-mpserver.html"><img src='up.gif'
102
border='0' height='32' alt='Up One Level' width='32'></A></td>
103
<td><a rel="next" title="4.5.6.2 Server Members"
104
rel="next" title="4.5.6.2 Server Members"
105
href="pyapi-mpsrv-mem.html"><img src='next.gif'
106
border='0' height='32' alt='Next Page' width='32'></A></td>
130
<td class='online-navigation'><a rel="prev" title="4.5.7 Server Object (mp_server)"
131
href="pyapi-mpserver.html"><img src='previous.png'
132
border='0' height='32' alt='Previous Page' width='32' /></A></td>
133
<td class='online-navigation'><a rel="parent" title="4.5.7 Server Object (mp_server)"
134
href="pyapi-mpserver.html"><img src='up.png'
135
border='0' height='32' alt='Up One Level' width='32' /></A></td>
136
<td class='online-navigation'><a rel="next" title="4.5.7.2 Server Members"
137
href="pyapi-mpsrv-mem.html"><img src='next.png'
138
border='0' height='32' alt='Next Page' width='32' /></A></td>
107
139
<td align="center" width="100%">Mod_python Manual</td>
108
<td><a rel="contents" title="Table of Contents"
109
rel="contents" title="Table of Contents"
110
href="contents.html"><img src='contents.gif'
111
border='0' height='32' alt='Contents' width='32'></A></td>
112
<td><img src='blank.gif'
113
border='0' height='32' alt='' width='32'></td>
114
<td><a rel="index" title="Index"
115
rel="index" title="Index"
116
href="genindex.html"><img src='index.gif'
117
border='0' height='32' alt='Index' width='32'></A></td>
140
<td class='online-navigation'><a rel="contents" title="Table of Contents"
141
href="contents.html"><img src='contents.png'
142
border='0' height='32' alt='Contents' width='32' /></A></td>
143
<td class='online-navigation'><img src='blank.png'
144
border='0' height='32' alt='' width='32' /></td>
145
<td class='online-navigation'><a rel="index" title="Index"
146
href="genindex.html"><img src='index.png'
147
border='0' height='32' alt='Index' width='32' /></A></td>
149
<div class='online-navigation'>
119
150
<b class="navlabel">Previous:</b>
120
<a class="sectref" rel="prev" href="pyapi-mpserver.html">4.5.6 Server Object (mp_server) </A>
151
<a class="sectref" rel="prev" href="pyapi-mpserver.html">4.5.7 Server Object (mp_server)</A>
121
152
<b class="navlabel">Up:</b>
122
<a class="sectref" rel="parent" href="pyapi-mpserver.html">4.5.6 Server Object (mp_server) </A>
153
<a class="sectref" rel="parent" href="pyapi-mpserver.html">4.5.7 Server Object (mp_server)</A>
123
154
<b class="navlabel">Next:</b>
124
<a class="sectref" rel="next" href="pyapi-mpsrv-mem.html">4.5.6.2 Server Members</A>
126
<span class="release-info">Release 3.2.10, documentation updated on July 19, 2006.</span>
155
<a class="sectref" rel="next" href="pyapi-mpsrv-mem.html">4.5.7.2 Server Members</A>
159
<span class="release-info">Release 3.3.1, documentation updated on January 29, 2007.</span>
128
161
<!--End of Navigation Panel-->