source: TI05-delivery/trunk/doc/epydoc/private/delivery.client.AuthClientHandler-class.html @ 1284

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

Documentation update

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.client.AuthClientHandler</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.client-module.html">Module&nbsp;client</a> ::
34        Class&nbsp;AuthClientHandler
35      </b></font></br>
36    </td>
37    <td><table cellpadding="0" cellspacing="0">
38      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/delivery.client.AuthClientHandler-class.html">hide&nbsp;private</a>]</font></td></tr>
39      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="delivery.client.AuthClientHandler-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 AuthClientHandler</h2>
45
46<pre class="base-tree">
47<a href="__builtin__.object-class.html"><code>object</code></a> --+
48         |
49        <b>AuthClientHandler</b>
50</pre><br />
51
52<hr/>
53
54Abstract base class specifying the client authentication callback interface.<hr/>
55
56
57<!-- =========== START OF METHOD SUMMARY =========== -->
58<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
59<tr bgcolor="#70b0f0" class="summary">
60  <th colspan="2">Method Summary</th></tr>
61<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
62  <td><code><span class="summary-sig"><a href="delivery.client.AuthClientHandler-class.html#authenticate" class="summary-sig-name"><code>authenticate</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
63<br />
64Authenticate with the server.</td></tr>
65<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
66  <td><code><span class="summary-sig"><a href="delivery.client.AuthClientHandler-class.html#recv" class="summary-sig-name"><code>recv</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
67<br />
68Receive a message from the server during authentication.</td></tr>
69<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
70  <td><code><span class="summary-sig"><a href="delivery.client.AuthClientHandler-class.html#send" class="summary-sig-name"><code>send</code></a>(<span class=summary-sig-arg>self</span>,
71          <span class=summary-sig-arg>buffer</span>)</span></code>
72<br />
73Send a message to the server during authentication.</td></tr>
74<tr bgcolor="#e8f0f8" class="group">
75  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
76<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
77  <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>
78<br />
79x.__init__(...) initializes x; see x.__class__.__doc__ for signature...</td></tr>
80<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
81  <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>
82<br />
83x.__delattr__('name') <==> del x.name...</td></tr>
84<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
85  <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>
86<br />
87x.__getattribute__('name') <==> x.name...</td></tr>
88<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
89  <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>
90<br />
91x.__hash__() <==> hash(x)...</td></tr>
92<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
93  <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>,
94          <span class=summary-sig-arg>S</span>,
95          <span class="summary-sig-vararg">...</span>)</span></code>
96<br />
97T.__new__(S, ...) -> a new object with type S, a subtype of T...</td></tr>
98<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
99  <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>
100<br />
101helper for pickle...</td></tr>
102<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
103  <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>
104<br />
105helper for pickle...</td></tr>
106<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
107  <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>
108<br />
109x.__repr__() <==> repr(x)...</td></tr>
110<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
111  <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>
112<br />
113x.__setattr__('name', value) <==> x.name = value...</td></tr>
114<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
115  <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>
116<br />
117x.__str__() <==> str(x)...</td></tr>
118</table><br />
119
120
121<!-- =========== START OF METHOD DETAILS =========== -->
122<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
123<tr bgcolor="#70b0f0" class="details">
124  <th colspan="2">Method Details</th></tr>
125</table>
126
127<a name="authenticate"></a>
128<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
129  <h3><span class="sig"><span class="sig-name">authenticate</span>(<span class=sig-arg>self</span>)</span>
130  </h3>
131Authenticate with the server.
132
133This method should be overridden in subclasses to implement authentication using
134the method calls self.send() and send.recv().  It is called by the bbftp layer from within
135connect().
136  <dl><dt></dt><dd>
137    <dl><dt><b>Returns:</b></dt>
138      <dd>
139a value indicating success or failure.      </dd>
140    </dl>
141  </dd></dl>
142</td></tr></table>
143
144<a name="recv"></a>
145<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
146  <h3><span class="sig"><span class="sig-name">recv</span>(<span class=sig-arg>self</span>)</span>
147  </h3>
148Receive a message from the server during authentication.
149
150This method must only be used from within self.authenticate() called from connect().
151  <dl><dt></dt><dd>
152    <dl><dt><b>Returns:</b></dt>
153      <dd>
154a string containing the message received.      </dd>
155    </dl>
156  </dd></dl>
157</td></tr></table>
158
159<a name="send"></a>
160<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
161  <h3><span class="sig"><span class="sig-name">send</span>(<span class=sig-arg>self</span>,
162          <span class=sig-arg>buffer</span>)</span>
163  </h3>
164Send a message to the server during authentication.
165
166This method must only be used from within self.authenticate() called from connect().
167  <dl><dt></dt><dd>
168    <dl><dt><b>Parameters:</b></dt>
169      <dd><code><b>buffer</b></code> -
170 a string containing the message to send.
171      </dd>
172    </dl>
173  </dd></dl>
174</td></tr></table>
175<br />
176
177
178<!-- =========== START OF NAVBAR =========== -->
179<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
180  <tr valign="center">
181    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
182    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
183    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
184    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
185    <th class="navbar" align="right" width="100%">
186      <table border="0" cellpadding="0" cellspacing="0">
187      <tr><th class="navbar" align="center">
188        <p class="nomargin">
189          NDG&nbsp;Delivery&nbsp;Service
190      </p></th></tr></table>
191    </th>
192  </tr>
193</table>
194
195<table border="0" cellpadding="0" cellspacing="0" width="100%">
196  <tr>
197    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jul  6 15:44:03 2006</font></td>
198    <td align="right"><a href="http://epydoc.sourceforge.net"
199                      ><font size="-2">http://epydoc.sf.net</font></a></td>
200  </tr>
201</table>
202</body>
203</html>
Note: See TracBrowser for help on using the repository browser.