<?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.component.misc.httpserver.cachedprovider.CachedFile</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.component-module.html">Package component</a> :: <a href="flumotion.component.misc-module.html">Package misc</a> :: <a href="flumotion.component.misc.httpserver-module.html">Package httpserver</a> :: <a href="flumotion.component.misc.httpserver.cachedprovider-module.html">Module cachedprovider</a> :: Class CachedFile </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 CachedFile</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html">fileprovider.File</a> --+ | <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+ | <strong class="uidshort">CachedFile</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.component.misc.httpserver.cachedprovider.CachedFile-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">plug</span>, <span class="summary-sig-arg">path</span>, <span class="summary-sig-arg">mimeType</span>)</span><br /> x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.__init__">source code</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.component.misc.httpserver.cachedprovider.CachedFile-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> str(x)</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.__str__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="flumotion.component.misc.httpserver.cachedprovider.CachedFile-class.html#getmtime" class="summary-sig-name">getmtime</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: the modification time of the file</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getmtime">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">long</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="flumotion.component.misc.httpserver.cachedprovider.CachedFile-class.html#getsize" class="summary-sig-name">getsize</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: the size of the file</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getsize">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">long</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="flumotion.component.misc.httpserver.cachedprovider.CachedFile-class.html#tell" class="summary-sig-name">tell</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: the current read/write position in the file</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.tell">source code</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.component.misc.httpserver.cachedprovider.CachedFile-class.html#seek" class="summary-sig-name">seek</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">offset</span>)</span><br /> Moves the reading/writing position inside the file.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.seek">source code</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.component.misc.httpserver.cachedprovider.CachedFile-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">size</span>)</span><br /> Reads the specified amount of data asynchronously.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.read">source code</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.component.misc.httpserver.cachedprovider.CachedFile-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> Close and cleanup the file.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.close">source code</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 name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.__del__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">dict</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="flumotion.component.misc.httpserver.cachedprovider.CachedFile-class.html#getLogFields" class="summary-sig-name">getLogFields</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: a dictionary of log fields related to the file usage</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getLogFields">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">(file, statinfo)</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_open"></a><span class="summary-sig-name">_open</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">path</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._open">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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 name="_closeSourceFile"></a><span class="summary-sig-name">_closeSourceFile</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">sourceFile</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._closeSourceFile">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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 name="_selectDelegate"></a><span class="summary-sig-name">_selectDelegate</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._selectDelegate">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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 name="_removeCachedFile"></a><span class="summary-sig-name">_removeCachedFile</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cachePath</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._removeCachedFile">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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 name="_tryTempFile"></a><span class="summary-sig-name">_tryTempFile</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">sourcePath</span>, <span class="summary-sig-arg">sourceFile</span>, <span class="summary-sig-arg">sourceInfo</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._tryTempFile">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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 name="_cacheFile"></a><span class="summary-sig-name">_cacheFile</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">sourcePath</span>, <span class="summary-sig-arg">sourceFile</span>, <span class="summary-sig-arg">sourceInfo</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile._cacheFile">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.misc.httpserver.fileprovider.File-class.html">fileprovider.File</a></code></b>: <code><a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#getMimeType">getMimeType</a></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>__subclasshook__</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>: <code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code> </p> </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 width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="logCategory"></a><span class="summary-name">logCategory</span> = <code title="'fileprovider-localcached'"><code class="variable-quote">'</code><code class="variable-string">fileprovider-localcached</code><code class="variable-quote">'</code></code><br /> Implementors can provide a category to log their messages under. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="mimeType"></a><span class="summary-name">mimeType</span> = <code title="None">None</code><br /> hash(x) </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="_delegate"></a><span class="summary-name">_delegate</span> = <code title="None">None</code><br /> hash(x) </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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">plug</span>, <span class="sig-arg">path</span>, <span class="sig-arg">mimeType</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.__init__">source code</a></span> </td> </tr></table> <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> <dl class="fields"> <dt>Overrides: object.__init__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Informal representation operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.__str__">source code</a></span> </td> </tr></table> <p>str(x)</p> <dl class="fields"> <dt>Overrides: object.__str__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="getmtime"></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">getmtime</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getmtime">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Returns: int</dt> <dd>the modification time of the file</dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#getmtime">fileprovider.File.getmtime</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="getsize"></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">getsize</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getsize">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Returns: long</dt> <dd>the size of the file</dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#getsize">fileprovider.File.getsize</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="tell"></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">tell</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.tell">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Returns: long</dt> <dd>the current read/write position in the file</dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#tell">fileprovider.File.tell</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="seek"></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">seek</span>(<span class="sig-arg">self</span>, <span class="sig-arg">offset</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.seek">source code</a></span> </td> </tr></table> <p>Moves the reading/writing position inside the file. Only support absolute offset from file start.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>offset</code></strong> - the byte offset from the start of the file to go to</li> </ul></dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#seek">fileprovider.File.seek</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="read"></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">read</span>(<span class="sig-arg">self</span>, <span class="sig-arg">size</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.read">source code</a></span> </td> </tr></table> <p>Reads the specified amount of data asynchronously.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>size</code></strong> - the amount of byte to read from the file</li> </ul></dd> <dt>Returns:</dt> <dd>a deferred fired with the read data or a failure. The data can be empty or smaller than the wanted size if the end of file is reached.</dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#read">fileprovider.File.read</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="close"></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">close</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.close">source code</a></span> </td> </tr></table> <p>Close and cleanup the file.</p> <dl class="fields"> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#close">fileprovider.File.close</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="getLogFields"></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">getLogFields</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.component.misc.httpserver.cachedprovider-pysrc.html#CachedFile.getLogFields">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Returns: dict</dt> <dd>a dictionary of log fields related to the file usage</dd> <dt>Overrides: <a href="flumotion.component.misc.httpserver.fileprovider.File-class.html#getLogFields">fileprovider.File.getLogFields</a> <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 Sun Sep 13 13:14:09 2009 </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>