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

<tr><td align="right">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.policies.ProtocolWrapper.html" target="_top">no frames</a>]</td></tr>

</table></td>

</tr></table>

<h2 class="class">Class ProtocolWrapper</h2>

<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+

<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+

ProtocolWrapper

</pre>

<dl><dt>Known Subclasses:</dt>

<dd>

<a href="twisted.protocols.policies.SpewingProtocol.html"><code>SpewingProtocol</code></a>,

<a href="twisted.protocols.policies.ThrottlingProtocol.html"><code>ThrottlingProtocol</code></a>,

<a href="twisted.protocols.policies.TimeoutProtocol.html"><code>TimeoutProtocol</code></a></dd></dl>

<hr/>

Wraps protocol instances and acts as their transport as well.

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><a name="__init__"></a>__init__(self,

factory,

wrappedProtocol)</code>

</td></tr>

<td><code><a name="__getattr__"></a>__getattr__(self,

name)</code>

</td></tr>

<td><code><a name="connectionLost"></a>connectionLost(self,

reason)</code>

</td></tr>

<td><code><a href="twisted.protocols.policies.ProtocolWrapper.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(self)</code>

Called when a connection is made.</td></tr>

<td><code><a href="twisted.protocols.policies.ProtocolWrapper.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(self,

data)</code>

Called whenever data is received.</td></tr>

<td><code><a name="getHost"></a>getHost(self)</code>

</td></tr>

<td><code><a name="getPeer"></a>getPeer(self)</code>

</td></tr>

<td><code><a name="loseConnection"></a>loseConnection(self)</code>

100

</td></tr>

101

102

<td><code><a href="twisted.protocols.policies.ProtocolWrapper.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(self,

103

transport)</code>

104

105

Make a connection to a transport and a server.</td></tr>

106

107

<td><code><a name="registerProducer"></a>registerProducer(self,

108

producer,

109

streaming)</code>

110

</td></tr>

111

112

<td><code><a name="stopConsuming"></a>stopConsuming(self)</code>

113

</td></tr>

114

115

<td><code><a name="unregisterProducer"></a>unregisterProducer(self)</code>

116

</td></tr>

117

118

<td><code><a name="write"></a>write(self,

119

data)</code>

120

</td></tr>

121

122

<td><code><a name="writeSequence"></a>writeSequence(self,

123

data)</code>

124

</td></tr>

125

126

<th colspan="2">    Inherited from Protocol</th></tr>

127

128

<td><code><a href="twisted.internet.protocol.Protocol.html#connectionFailed" class="summary-sig-name"><code>connectionFailed</code></a>(self)</code>

129

130

(Deprecated)</td></tr>

131

</table>

132

133

134

135

136

137

<th colspan="2">Class Variable Summary</th></tr>

138

<tr><td align="right" valign="top" width="15%"><code>tuple</code></td>

139

<td><a href="twisted.protocols.policies.ProtocolWrapper.html#__implements__"><code>__implements__</code></a> = ,)"><code>(<class twisted.internet.interfaces.ITr...</code>

140

</td></tr>

141

142

<td><a href="twisted.protocols.policies.ProtocolWrapper.html#disconnecting"><code>disconnecting</code></a> = 0                                                                     </td></tr>

143

144

<th colspan="2">    Inherited from BaseProtocol</th></tr>

145

146

<td><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a> = 0                                                                     </td></tr>

147

<tr><td align="right" valign="top" width="15%"><code>NoneType</code></td>

148

<td><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a> = None                                                                  </td></tr>

149

</table>

150

151

152

153

154

155

<th colspan="2">Method Details</th></tr>

156

</table>

157

158

159

160

<h3>connectionMade(self)

161

</h3>

162

Called when a connection is made.

163

This may be considered the initializer of the protocol, because it

164

is called when the connection is completed. For clients, this is called

165

once the connection to the server has been established; for servers,

166

this is called after an accept() call stops blocking and a socket has

167

been received. If you need to send any greeting or initial message, do

168

it here.

169

170

<dl><dt>Overrides:</dt>

171

<dd><a href="twisted.internet.protocol.BaseProtocol.html#connectionMade"><code>twisted.internet.protocol.BaseProtocol.connectionMade</code></a> (inherited documentation)

172

</dd>

173

</dl>

174

</dd></dl>

175

</td></tr></table>

176

177

178

179

<h3>dataReceived(self,

180

data)

181

</h3>

182

Called whenever data is received.

183

Use this method to translate to a higher-level message. Usually,

184

some callback will be made upon the receipt of each complete protocol

185

message.

186

187

<dl><dt>Parameters:</dt>

188

<dd><code>data</code> -

189

a string of indeterminate length. Please keep in mind that you

190

will probably need to buffer some data, as partial (or multiple)

191

protocol messages may be received! I recommend that unit tests

192

for protocols call through to this method with differing chunk

193

sizes, down to one byte at a time.

194

</dd>

195

</dl>

196

<dl><dt>Overrides:</dt>

197

<dd><a href="twisted.internet.protocol.Protocol.html#dataReceived"><code>twisted.internet.protocol.Protocol.dataReceived</code></a> (inherited documentation)

198

</dd>

199

</dl>

200

</dd></dl>

201

</td></tr></table>

202

203

204

205

<h3>makeConnection(self,

206

transport)

207

</h3>

208

Make a connection to a transport and a server.

209

This sets the 'transport' attribute of this Protocol, and calls the

210

connectionMade() callback.

211

212

<dl><dt>Overrides:</dt>

213

<dd><a href="twisted.internet.protocol.BaseProtocol.html#makeConnection"><code>twisted.internet.protocol.BaseProtocol.makeConnection</code></a> (inherited documentation)

214

</dd>

215

</dl>

216

</dd></dl>

217

</td></tr></table>

218

219

220

221

222

223

224

<th colspan="2">Class Variable Details</th></tr>

225

</table>

226

227

228

<h3>__implements__</h3>

229

<dl>

230

231

<dd>

232

<dl>

233

234

<dd>

235

<code>tuple</code>

236

237

</dd>

238

,)"> <dt>Value:</dt>

239

240

241

(<class twisted.internet.interfaces.ITransport at 0x8254024>,) </pre>

242

</td></tr></table></dd>

243

</dl>

244

</dd>

245

</dl></td></tr></table>

246

247

248

<h3>disconnecting</h3>

249

<dl>

250

251

<dd>

252

<dl>

253

254

<dd>

255

256

257

</dd>

258

<dt>Value:</dt>

259

260

261

0                                                                     </pre>

262

</td></tr></table></dd>

263

</dl>

264

</dd>

265

</dl></td></tr></table>

266

267

268

269

270

271

272

273

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

274

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

275

276

277

278

279

280

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

281

</th></tr></table>

282

</th>

283

</tr>

284

</table>

285

286

287

<tr>

288

<td align="left">Generated by Epydoc 2.0 on Sat May 15 20:07:52 2004</td>

289

<td align="right"><a href="http://epydoc.sourceforge.net"

290

>http://epydoc.sf.net</a></td>

291

</tr>

292

</table>

293

</body>

294

</html>

Older »