source: TI05-delivery/trunk/doc/epydoc/public/delivery.server.BasicClientAuthHandler-class.html @ 1198

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