source: TI05-delivery/trunk/doc/epydoc/private/delivery.client-module.html @ 1272

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

Autogenerated documentation update.
VERSION has been iterated to 0.1.3. This version is close to being
the ALPHA release and will be tagged shortly.

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</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;client
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.client-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.client-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.client</h2>
44
45Interface to the BBftp client.
46<hr/>
47<p><b>Author:</b> Stephen Pascoe</p>
48
49<p><b>Copyright:</b> Copyright (C) 2006 CCLRC & NERC
50</p>
51
52<p><b>License:</b> This software may be distributed under the terms of the Q Public Licence, version 1.0 or later.
53</p>
54
55
56<!-- =========== START OF CLASSES =========== -->
57<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58<tr bgcolor="#70b0f0" class="summary">
59  <th colspan="2">Classes</th></tr>
60<tr><td width="15%">
61  <b><a href="delivery.client.AuthClientHandler-class.html"><code>AuthClientHandler</code></a></b></td>
62  <td>Abstract base class specifying the client authentication callback interface.</td></tr>
63</table><br />
64
65
66<!-- =========== START OF FUNCTION SUMMARY =========== -->
67<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
68<tr bgcolor="#70b0f0" class="summary">
69  <th colspan="2">Function Summary</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.client-module.html#close" class="summary-sig-name"><code>close</code></a>()</span></code>
72<br />
73Close the 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.client-module.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>authClientHandler</span>,
76          <span class=summary-sig-arg>args</span>)</span></code>
77<br />
78Connect to the bbftp server.</td></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="delivery.client-module.html#docommand" class="summary-sig-name"><code>docommand</code></a>(<span class=summary-sig-arg>cmd</span>)</span></code>
81<br />
82Execute a BBFtp command.</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="delivery.client-module.html#isConnected" class="summary-sig-name"><code>isConnected</code></a>()</span></code>
85<br />
86Returns a bool indicating whether we are connected to a server.</td></tr>
87</table><br />
88
89
90<!-- =========== START OF FUNCTION DETAILS =========== -->
91<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
92<tr bgcolor="#70b0f0" class="details">
93  <th colspan="2">Function Details</th></tr>
94</table>
95
96<a name="close"></a>
97<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
98  <h3><span class="sig"><span class="sig-name">close</span>()</span>
99  </h3>
100Close the connection.  <dl><dt></dt><dd>
101  </dd></dl>
102</td></tr></table>
103
104<a name="connect"></a>
105<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
106  <h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>authClientHandler</span>,
107          <span class=sig-arg>args</span>)</span>
108  </h3>
109Connect to the bbftp server.
110  <dl><dt></dt><dd>
111    <dl><dt><b>Parameters:</b></dt>
112      <dd><code><b>authClientHandler</b></code> -
113 an instance of AuthClientHandler
114      <dd><code><b>args</b></code> -
115 a list of command line arguments passed to the client code.
116      </dd>
117    </dl>
118    <dl><dt><b>Returns:</b></dt>
119      <dd>
120a list of bbftp client output messages.      </dd>
121    </dl>
122  </dd></dl>
123</td></tr></table>
124
125<a name="docommand"></a>
126<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
127  <h3><span class="sig"><span class="sig-name">docommand</span>(<span class=sig-arg>cmd</span>)</span>
128  </h3>
129Execute a BBFtp command.
130  <dl><dt></dt><dd>
131    <dl><dt><b>Parameters:</b></dt>
132      <dd><code><b>cmd</b></code> -
133 a string containing the command.
134      </dd>
135    </dl>
136    <dl><dt><b>Returns:</b></dt>
137      <dd>
138a list of BBFtp client messages in response.      </dd>
139    </dl>
140  </dd></dl>
141</td></tr></table>
142
143<a name="isConnected"></a>
144<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
145  <h3><span class="sig"><span class="sig-name">isConnected</span>()</span>
146  </h3>
147Returns a bool indicating whether we are connected to a server.  <dl><dt></dt><dd>
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 Mon Jul  3 17:08:03 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.