twisted.internet.interfaces.html   [plain text]


<?xml version="1.0" encoding="iso-8859-1"?>
<!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>twisted.internet.interfaces</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">

<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <font size="-1"><b class="breadcrumbs">
        <a href="twisted.html">Package&nbsp;twisted</a> ::
        <a href="twisted.internet.html">Package&nbsp;internet</a> ::
        Module&nbsp;interfaces
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.internet.interfaces.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.internet.interfaces</h2>

<p>Interface documentation.</p>
<p>API Stability: stable, other than IReactorUDP (semi-stable) and 
IReactorMulticast (unstable).</p>
Maintainer: <a href="mailto:twisted&#64;itamarst.org">Itamar 
Shtull-Trauring</a>
<hr/>

<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Classes</th></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IAddress.html"><code>IAddress</code></a></b></td>
  <td>An address, e.g.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IConnector.html"><code>IConnector</code></a></b></td>
  <td>Object used to interface between connections and protocols.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IConsumer.html"><code>IConsumer</code></a></b></td>
  <td>A consumer consumes data from a producer.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IDelayedCall.html"><code>IDelayedCall</code></a></b></td>
  <td>A scheduled call.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IFileDescriptor.html"><code>IFileDescriptor</code></a></b></td>
  <td>A file descriptor.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IFinishableConsumer.html"><code>IFinishableConsumer</code></a></b></td>
  <td>A Consumer for producers that finish.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IListeningPort.html"><code>IListeningPort</code></a></b></td>
  <td>A listening port.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IMulticastTransport.html"><code>IMulticastTransport</code></a></b></td>
  <td>Additional functionality for multicast UDP.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IProcessTransport.html"><code>IProcessTransport</code></a></b></td>
  <td>A process transport.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IProducer.html"><code>IProducer</code></a></b></td>
  <td>A producer produces data for a consumer.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IProtocol.html"><code>IProtocol</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IProtocolFactory.html"><code>IProtocolFactory</code></a></b></td>
  <td>Interface for protocol factories.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IPullProducer.html"><code>IPullProducer</code></a></b></td>
  <td>A pull producer, also known as a non-streaming producer, is expected 
to produce data each time resumeProducing() is called.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IPushProducer.html"><code>IPushProducer</code></a></b></td>
  <td>A push producer, also known as a streaming producer is expected to 
produce (write to this consumer) data on a continous basis, unless it has 
been paused.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorArbitrary.html"><code>IReactorArbitrary</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorCore.html"><code>IReactorCore</code></a></b></td>
  <td>Core methods that a Reactor must implement.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorFDSet.html"><code>IReactorFDSet</code></a></b></td>
  <td>Implement me to be able to use <a 
href="twisted.internet.abstract.FileDescriptor.html" 
class="link"><code>FileDescriptor</code></a> type resources.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorMulticast.html"><code>IReactorMulticast</code></a></b></td>
  <td>UDP socket methods that support multicast.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorPluggableResolver.html"><code>IReactorPluggableResolver</code></a></b></td>
  <td>A reactor with a pluggable name resolver interface.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorProcess.html"><code>IReactorProcess</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorSSL.html"><code>IReactorSSL</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorTCP.html"><code>IReactorTCP</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorThreads.html"><code>IReactorThreads</code></a></b></td>
  <td>Dispatch methods to be run in threads.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorTime.html"><code>IReactorTime</code></a></b></td>
  <td>Time methods that a Reactor should implement.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorUDP.html"><code>IReactorUDP</code></a></b></td>
  <td>UDP socket methods.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorUNIX.html"><code>IReactorUNIX</code></a></b></td>
  <td>UNIX socket methods.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReactorUNIXDatagram.html"><code>IReactorUNIXDatagram</code></a></b></td>
  <td>datagram UNIX socket methods.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReadDescriptor.html"><code>IReadDescriptor</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IReadWriteDescriptor.html"><code>IReadWriteDescriptor</code></a></b></td>
  <td>I am a <a href="twisted.internet.abstract.FileDescriptor.html" 
class="link"><code>FileDescriptor</code></a> that can both read and 
write.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IResolver.html"><code>IResolver</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IResolverSimple.html"><code>IResolverSimple</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IServiceCollection.html"><code>IServiceCollection</code></a></b></td>
  <td>An object which provides access to a collection of services.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.ISSLTransport.html"><code>ISSLTransport</code></a></b></td>
  <td>A SSL/TLS based transport.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.ISystemHandle.html"><code>ISystemHandle</code></a></b></td>
  <td>An object that wraps a networking OS-specific handle.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.ITCPTransport.html"><code>ITCPTransport</code></a></b></td>
  <td>A TCP based transport.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.ITLSTransport.html"><code>ITLSTransport</code></a></b></td>
  <td>A TCP transport that supports switching to TLS midstream.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.ITransport.html"><code>ITransport</code></a></b></td>
  <td>I am a transport for bytes.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IUDPConnectedTransport.html"><code>IUDPConnectedTransport</code></a></b></td>
  <td>DEPRECATED.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IUDPTransport.html"><code>IUDPTransport</code></a></b></td>
  <td>Transport for UDP DatagramProtocols.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IUNIXDatagramConnectedTransport.html"><code>IUNIXDatagramConnectedTransport</code></a></b></td>
  <td>Transport for UDP ConnectedPacketProtocols.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IUNIXDatagramTransport.html"><code>IUNIXDatagramTransport</code></a></b></td>
  <td>Transport for UDP PacketProtocols.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.interfaces.IWriteDescriptor.html"><code>IWriteDescriptor</code></a></b></td>
  <td>&nbsp;</td></tr>
</table><br />


<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
  <tr>
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:22 2004</font></td>
    <td align="right"><a href="http://epydoc.sourceforge.net"
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
  </tr>
</table>
</body>
</html>