source: TI05-delivery/trunk/doc/epydoc/private/delivery.server.BasicClientAuthHandler-class.html @ 1187

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

Auto-generated documentation included for the python-server interface.

Some file clean up prior to alpha. Fixed some confusion between authentication
and authorisation in the API.

The embedded client test case is disabled because it doesn't work :-(.

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.BasicClientAuthHandler</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" width="100%"></th>
20  </tr>
21</table>
22<table width="100%" cellpadding="0" cellspacing="0">
23  <tr valign="top">
24    <td width="100%">
25      <font size="-1"><b class="breadcrumbs">
26        <a href="delivery-module.html">Package&nbsp;delivery</a> ::
27        <a href="delivery.server-module.html">Module&nbsp;server</a> ::
28        Class&nbsp;BasicClientAuthHandler
29      </b></font></br>
30    </td>
31    <td><table cellpadding="0" cellspacing="0">
32      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/delivery.server.BasicClientAuthHandler-class.html">hide&nbsp;private</a>]</font></td></tr>
33      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="delivery.server.BasicClientAuthHandler-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
34    </table></td>
35</tr></table>
36
37<!-- =========== START OF CLASS DESCRIPTION =========== -->
38<h2 class="class">Type BasicClientAuthHandler</h2>
39
40<pre class="base-tree">
41 <a href="__builtin__.object-class.html"><code>object</code></a> --+   
42          |   
43<a href="delivery.server.AuthHandler-class.html"><code>AuthHandler</code></a> --+
44              |
45             <b>BasicClientAuthHandler</b>
46</pre><br />
47
48<hr/>
49
50This class makes communicating with the stand alone bbftp client slightly easier.
51Mainly for use during testing.<hr/>
52
53
54<!-- =========== START OF METHOD SUMMARY =========== -->
55<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
56<tr bgcolor="#70b0f0" class="summary">
57  <th colspan="2">Method Summary</th></tr>
58<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
59  <td><code><span class="summary-sig"><a href="delivery.server.BasicClientAuthHandler-class.html#recvCStr" class="summary-sig-name"><code>recvCStr</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
60<br />
61Receive a message from the client which may contain \0 characters indicating message end.</td></tr>
62<tr bgcolor="#e8f0f8" class="group">
63  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from AuthHandler</th></tr>
64<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
65  <td><code><span class="summary-sig"><a href="delivery.server.AuthHandler-class.html#authenticate" class="summary-sig-name"><code>authenticate</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
66<br />
67Authenticate a connection.</td></tr>
68<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
69  <td><code><span class="summary-sig"><a href="delivery.server.AuthHandler-class.html#recv" class="summary-sig-name"><code>recv</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
70<br />
71Receive a message from the client during authorisation.</td></tr>
72<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
73  <td><code><span class="summary-sig"><a href="delivery.server.AuthHandler-class.html#send" class="summary-sig-name"><code>send</code></a>(<span class=summary-sig-arg>self</span>,
74          <span class=summary-sig-arg>buffer</span>)</span></code>
75<br />
76Send a message to the client during authorisation.</td></tr>
77<tr bgcolor="#e8f0f8" class="group">
78  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
79<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
80  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
81<br />
82x.__init__(...) initializes x; see x.__class__.__doc__ for signature...</td></tr>
83<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
84  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
85<br />
86x.__delattr__('name') <==> del x.name...</td></tr>
87<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
88  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
89<br />
90x.__getattribute__('name') <==> x.name...</td></tr>
91<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
92  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
93<br />
94x.__hash__() <==> hash(x)...</td></tr>
95<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
96  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
97          <span class=summary-sig-arg>S</span>,
98          <span class="summary-sig-vararg">...</span>)</span></code>
99<br />
100T.__new__(S, ...) -> a new object with type S, a subtype of T...</td></tr>
101<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
102  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
103<br />
104helper for pickle...</td></tr>
105<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
106  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
107<br />
108helper for pickle...</td></tr>
109<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
110  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
111<br />
112x.__repr__() <==> repr(x)...</td></tr>
113<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
114  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
115<br />
116x.__setattr__('name', value) <==> x.name = value...</td></tr>
117<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
118  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
119<br />
120x.__str__() <==> str(x)...</td></tr>
121</table><br />
122
123
124<!-- =========== START OF METHOD DETAILS =========== -->
125<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
126<tr bgcolor="#70b0f0" class="details">
127  <th colspan="2">Method Details</th></tr>
128</table>
129
130<a name="recvCStr"></a>
131<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
132  <h3><span class="sig"><span class="sig-name">recvCStr</span>(<span class=sig-arg>self</span>)</span>
133  </h3>
134Receive a message from the client which may contain \0 characters indicating message end.
135
136The message is truncated to the first \0 character.
137  <dl><dt></dt><dd>
138    <dl><dt><b>Returns:</b></dt>
139      <dd>
140a string containing the message received.      </dd>
141    </dl>
142  </dd></dl>
143</td></tr></table>
144<br />
145
146
147<!-- =========== START OF NAVBAR =========== -->
148<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
149  <tr valign="center">
150    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
151    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
152    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
153    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
154    <th class="navbar" width="100%"></th>
155  </tr>
156</table>
157
158<table border="0" cellpadding="0" cellspacing="0" width="100%">
159  <tr>
160    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jun 15 10:05:48 2006</font></td>
161    <td align="right"><a href="http://epydoc.sourceforge.net"
162                      ><font size="-2">http://epydoc.sf.net</font></a></td>
163  </tr>
164</table>
165</body>
166</html>
Note: See TracBrowser for help on using the repository browser.