<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>flumotion.twisted.fdserver.FDClient</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.twisted-module.html">Package twisted</a> ::
<a href="flumotion.twisted.fdserver-module.html">Module fdserver</a> ::
Class FDClient
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class FDClient</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDClient">source code</a></span></p>
<pre class="base-tree">
twisted.python.log.Logger --+
|
twisted.persisted.styles.Ephemeral --+
|
object --+
|
twisted.internet.abstract.FileDescriptor --+
|
twisted.internet.tcp._SocketCloser --+
|
twisted.internet.tcp.Connection --+
|
twisted.internet.tcp.BaseClient --+
|
twisted.internet.unix.Client --+
|
<strong class="uidshort">FDClient</strong>
</pre>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.fdserver.FDClient-class.html#doRead" class="summary-sig-name">doRead</a>(<span class="summary-sig-arg">self</span>)</span><br />
Calls self.protocol.dataReceived with all available data.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDClient.doRead">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.unix.Client</code></b>:
<code>__init__</code>,
<code>getHost</code>,
<code>getPeer</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.BaseClient</code></b>:
<code>__provides__</code>,
<code>connectionLost</code>,
<code>createInternetSocket</code>,
<code>doConnect</code>,
<code>failIfNotConnected</code>,
<code>resolveAddress</code>,
<code>startTLS</code>,
<code>stopConnecting</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.BaseClient</code></b> (private):
<code>_connectDone</code>,
<code>_finishInit</code>,
<code>_setRealAddress</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.Connection</code></b>:
<code>doWrite</code>,
<code>getHandle</code>,
<code>getTcpKeepAlive</code>,
<code>getTcpNoDelay</code>,
<code>logPrefix</code>,
<code>readConnectionLost</code>,
<code>setTcpKeepAlive</code>,
<code>setTcpNoDelay</code>,
<code>write</code>,
<code>writeSequence</code>,
<code>writeSomeData</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.Connection</code></b> (private):
<code>_closeWriteConnection</code>,
<code>_startTLS</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.abstract.FileDescriptor</code></b>:
<code>fileno</code>,
<code>loseConnection</code>,
<code>loseWriteConnection</code>,
<code>pauseProducing</code>,
<code>registerProducer</code>,
<code>resumeProducing</code>,
<code>startReading</code>,
<code>startWriting</code>,
<code>stopConsuming</code>,
<code>stopProducing</code>,
<code>stopReading</code>,
<code>stopWriting</code>,
<code>unregisterProducer</code>,
<code>writeConnectionLost</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.abstract.FileDescriptor</code></b> (private):
<code>_postLoseConnection</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.python.log.Logger</code></b>:
<code>__providedBy__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.persisted.styles.Ephemeral</code></b>:
<code>__getstate__</code>,
<code>__setstate__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp._SocketCloser</code></b> (private):
<code>_closeSocket</code>
</p></div>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.unix.Client</code></b>:
<code>addressFamily</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.BaseClient</code></b>:
<code>__implemented__</code>,
<code>socketType</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.Connection</code></b>:
<code>TLS</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.Connection</code></b> (private):
<code>_tlsWaiting</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.abstract.FileDescriptor</code></b>:
<code>SEND_LIMIT</code>,
<code>bufferSize</code>,
<code>connected</code>,
<code>dataBuffer</code>,
<code>disconnected</code>,
<code>disconnecting</code>,
<code>offset</code>,
<code>producer</code>,
<code>producerPaused</code>,
<code>streamingProducer</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.abstract.FileDescriptor</code></b> (private):
<code>_writeDisconnected</code>,
<code>_writeDisconnecting</code>
</p></div>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp._SocketCloser</code></b> (private):
<code>_socketShutdownMethod</code>
</p></div>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.tcp.Connection</code></b>:
<code>logstr</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="doRead"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">doRead</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.fdserver-pysrc.html#FDClient.doRead">source code</a></span>
</td>
</tr></table>
<p>Calls self.protocol.dataReceived with all available data.</p>
<p>This reads up to self.bufferSize bytes of data from its socket, then
calls self.dataReceived(data) to process it. If the connection is not
lost through an error in the physical recv(), this function will return
the result of the dataReceived call.</p>
<dl class="fields">
<dt>Overrides:
twisted.internet.abstract.FileDescriptor.doRead
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Wed Aug 11 21:33:17 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
