~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.internet.protocol.ProtocolToConsumerAdapter.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
ImportĀ upstreamĀ versionĀ 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>twisted.internet.protocol.ProtocolToConsumerAdapter</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="twisted.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
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
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="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.internet.html">Package&nbsp;internet</a> ::
 
34
        <a href="twisted.internet.protocol.html">Module&nbsp;protocol</a> ::
 
35
        Class&nbsp;ProtocolToConsumerAdapter
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.internet.protocol.ProtocolToConsumerAdapter.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">Class ProtocolToConsumerAdapter</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="twisted.python.components.Adapter.html"><code>Adapter</code></a> --+
 
48
          |
 
49
         <b>ProtocolToConsumerAdapter</b>
 
50
</pre><br />
 
51
 
 
52
<hr/>
 
53
 
 
54
This class is unstable.
 
55
<hr/>
 
56
 
 
57
 
 
58
<!-- =========== START OF METHOD SUMMARY =========== -->
 
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
60
<tr bgcolor="#70b0f0" class="summary">
 
61
  <th colspan="2">Method Summary</th></tr>
 
62
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
63
  <td><code><a name="registerProducer"></a><span class="summary-sig"><span class="summary-sig-name">registerProducer</span>(<span class=summary-sig-arg>self</span>,
 
64
          <span class=summary-sig-arg>producer</span>,
 
65
          <span class=summary-sig-arg>streaming</span>)</span></code>
 
66
</td></tr>
 
67
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
68
  <td><code><a name="unregisterProducer"></a><span class="summary-sig"><span class="summary-sig-name">unregisterProducer</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
69
</td></tr>
 
70
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
71
  <td><code><a name="write"></a><span class="summary-sig"><span class="summary-sig-name">write</span>(<span class=summary-sig-arg>self</span>,
 
72
          <span class=summary-sig-arg>data</span>)</span></code>
 
73
</td></tr>
 
74
<tr bgcolor="#e8f0f8" class="group">
 
75
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Adapter</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="twisted.python.components.Adapter.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
 
78
          <span class=summary-sig-arg>original</span>)</span></code>
 
79
<br />
 
80
Set my 'original' attribute to be the object I am adapting.</td></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
82
  <td><code><span class="summary-sig"><a href="twisted.python.components.Adapter.html#getComponent" class="summary-sig-name"><code>getComponent</code></a>(<span class=summary-sig-arg>self</span>,
 
83
          <span class=summary-sig-arg>interface</span>,
 
84
          <span class=summary-sig-arg>registry</span>,
 
85
          <span class=summary-sig-arg>default</span>)</span></code>
 
86
<br />
 
87
I forward getComponent to self.original if it has it, otherwise I 
 
88
simply return default.</td></tr>
 
89
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
90
  <td><code><span class="summary-sig"><a href="twisted.python.components.Adapter.html#isuper" class="summary-sig-name"><code>isuper</code></a>(<span class=summary-sig-arg>self</span>,
 
91
          <span class=summary-sig-arg>iface</span>,
 
92
          <span class=summary-sig-arg>adapter</span>)</span></code>
 
93
<br />
 
94
Forward isuper to self.original</td></tr>
 
95
</table><br />
 
96
 
 
97
 
 
98
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
99
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
100
<tr bgcolor="#70b0f0" class="summary">
 
101
  <th colspan="2">Class Variable Summary</th></tr>
 
102
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>class</code></font></td>
 
103
  <td><a name="__implements__"></a><b><code>__implements__</code></b> = <a href="twisted.internet.interfaces.IConsumer.html"><code>twisted.internet.interfaces.IConsumer</code></a></td></tr>
 
104
<tr bgcolor="#e8f0f8" class="group">
 
105
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Adapter</th></tr>
 
106
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
107
<td><b><a href="twisted.python.components.Adapter.html#multiComponent"><code>multiComponent</code></a></b>: If this adapter is persistent, should it be automatically registered 
 
108
for all appropriate interfaces.</td></tr>
 
109
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
110
<td><b><a href="twisted.python.components.Adapter.html#temporaryAdapter"><code>temporaryAdapter</code></a></b>: If this is True, the adapter will not be persisted on the 
 
111
Componentized.</td></tr>
 
112
</table><br />
 
113
 
 
114
 
 
115
<!-- =========== START OF NAVBAR =========== -->
 
116
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
117
  <tr valign="center">
 
118
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
119
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
120
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
121
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
122
    <th class="navbar" align="right" width="100%">
 
123
      <table border="0" cellpadding="0" cellspacing="0">
 
124
      <tr><th class="navbar" align="center">
 
125
        <p class="nomargin">
 
126
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
127
      </p></th></tr></table>
 
128
    </th>
 
129
  </tr>
 
130
</table>
 
131
 
 
132
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
133
  <tr>
 
134
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:17 2004</font></td>
 
135
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
136
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
137
  </tr>
 
138
</table>
 
139
</body>
 
140
</html>