source: TI05-delivery/trunk/doc/epydoc/private/delivery.server-module.html @ 1198

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/doc/epydoc/private/delivery.server-module.html@1198
Revision 1198, 7.4 KB checked in by spascoe, 13 years ago (diff)

Updated epydoc documentation.

Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>delivery.server</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8</head>
9<body bgcolor="white" text="black" link="blue" vlink="#204080"
10      alink="#204080">
11
12<!-- =========== START OF NAVBAR =========== -->
13<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14  <tr valign="center">
15    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19    <th class="navbar" align="right" width="100%">
20      <table border="0" cellpadding="0" cellspacing="0">
21      <tr><th class="navbar" align="center">
22        <p class="nomargin">
23          NDG&nbsp;Delivery&nbsp;Service
24      </p></th></tr></table>
25    </th>
26  </tr>
27</table>
28<table width="100%" cellpadding="0" cellspacing="0">
29  <tr valign="top">
30    <td width="100%">
31      <font size="-1"><b class="breadcrumbs">
32        <a href="delivery-module.html">Package&nbsp;delivery</a> ::
33        Module&nbsp;server
34      </b></font></br>
35    </td>
36    <td><table cellpadding="0" cellspacing="0">
37      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/delivery.server-module.html">hide&nbsp;private</a>]</font></td></tr>
38      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="delivery.server-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
39    </table></td>
40</tr></table>
41
42<!-- =========== START OF MODULE DESCRIPTION =========== -->
43<h2 class="module">Module delivery.server</h2>
44
45Start a bbftp server process and define python callbacks for authentication and authorisation.
46
47Interface to the BBftp server.
48<hr/>
49<p><b>Author:</b> Stephen Pascoe</p>
50
51<p><b>Copyright:</b> Copyright (C) 2006 CCLRC & NERC
52</p>
53
54<p><b>License:</b> This software may be distributed under the terms of the Q Public Licence, version 1.0 or later.
55</p>
56
57
58<!-- =========== START OF CLASSES =========== -->
59<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
60<tr bgcolor="#70b0f0" class="summary">
61  <th colspan="2">Classes</th></tr>
62<tr><td width="15%">
63  <b><a href="delivery.server.AuthHandler-class.html"><code>AuthHandler</code></a></b></td>
64  <td>Abstract base class for implementing authentication.</td></tr>
65<tr><td width="15%">
66  <b><a href="delivery.server.AuthzHandler-class.html"><code>AuthzHandler</code></a></b></td>
67  <td>Abstract base class for implementing authorisation.</td></tr>
68<tr><td width="15%">
69  <b><a href="delivery.server.BasicClientAuthHandler-class.html"><code>BasicClientAuthHandler</code></a></b></td>
70  <td>This class makes communicating with the stand alone bbftp client slightly easier.</td></tr>
71<tr><td width="15%">
72  <b><a href="delivery.server.LiberalAuthzHandler-class.html"><code>LiberalAuthzHandler</code></a></b></td>
73  <td>Allow everything.</td></tr>
74<tr><td width="15%">
75  <b><a href="delivery.server.MSG-class.html"><code>MSG</code></a></b></td>
76  <td>Static class containing message codes used by bbftp.</td></tr>
77<tr><td width="15%">
78  <b><a href="delivery.server.TROPT-class.html"><code>TROPT</code></a></b></td>
79  <td>Static class containing constants used by bbftp in the transferoption parameter.</td></tr>
80</table><br />
81
82
83<!-- =========== START OF EXCEPTIONS =========== -->
84<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
85<tr bgcolor="#70b0f0" class="summary">
86  <th colspan="2">Exceptions</th></tr>
87<tr><td width="15%">
88  <b><a href="delivery.server.AuthenticationFailure-class.html"><code>AuthenticationFailure</code></a></b></td>
89  <td>Signals authentication failed.</td></tr>
90<tr><td width="15%">
91  <b><a href="delivery.server.AuthorisationFailure-class.html"><code>AuthorisationFailure</code></a></b></td>
92  <td>Signals authorisation failed.</td></tr>
93</table><br />
94
95
96<!-- =========== START OF FUNCTION SUMMARY =========== -->
97<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
98<tr bgcolor="#70b0f0" class="summary">
99  <th colspan="2">Function Summary</th></tr>
100<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
101  <td><code><span class="summary-sig"><a href="delivery.server-module.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>authHandler</span>,
102          <span class=summary-sig-arg>args</span>)</span></code>
103<br />
104Start the bbftp server.</td></tr>
105</table><br />
106
107
108<!-- =========== START OF FUNCTION DETAILS =========== -->
109<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
110<tr bgcolor="#70b0f0" class="details">
111  <th colspan="2">Function Details</th></tr>
112</table>
113
114<a name="start"></a>
115<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
116  <h3><span class="sig"><span class="sig-name">start</span>(<span class=sig-arg>authHandler</span>,
117          <span class=sig-arg>args</span>)</span>
118  </h3>
119Start the bbftp server.
120
121The server performs a fork() during initialisation, the child process remains in
122the server's main loop and the parent returns from this function.  The server process
123calls authHandler.authorise() on each connection to do authentication/authorisation.
124  <dl><dt></dt><dd>
125    <dl><dt><b>Parameters:</b></dt>
126      <dd><code><b>authHandler</b></code> -
127 an instance of AuthHandler.
128      <dd><code><b>args</b></code> -
129 a list of command line arguments.
130      </dd>
131    </dl>
132    <dl><dt><b>Returns:</b></dt>
133      <dd>
134the PID of the server process.      </dd>
135    </dl>
136<p><b>Note:</b> because the server process forks, authHandler will not see any changes to the python
137    interpreter following the call to start().
138</p>
139
140  </dd></dl>
141</td></tr></table>
142<br />
143
144
145<!-- =========== START OF NAVBAR =========== -->
146<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
147  <tr valign="center">
148    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
149    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
150    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
151    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
152    <th class="navbar" align="right" width="100%">
153      <table border="0" cellpadding="0" cellspacing="0">
154      <tr><th class="navbar" align="center">
155        <p class="nomargin">
156          NDG&nbsp;Delivery&nbsp;Service
157      </p></th></tr></table>
158    </th>
159  </tr>
160</table>
161
162<table border="0" cellpadding="0" cellspacing="0" width="100%">
163  <tr>
164    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jun 15 15:59:13 2006</font></td>
165    <td align="right"><a href="http://epydoc.sourceforge.net"
166                      ><font size="-2">http://epydoc.sf.net</font></a></td>
167  </tr>
168</table>
169</body>
170</html>
Note: See TracBrowser for help on using the repository browser.